- Notifications
You must be signed in to change notification settings - Fork1
Vue Video Player - Lightweight, customizable, and easy-to-implement vue video player.
License
NotificationsYou must be signed in to change notification settings
display-design-studio/vue-player
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Lightweight, customizable, and easy-to-implement vue video player.
$ npm i @display-studio/vue-player
<scriptsetup>import{VuePlayer} from '@display-studio/vue-player'const sources = [{src:'YOUR_URL',type:'video/mp4',media:"(min-width: 900px)"},{src:'YOUR_URL_MOBILE',type:'video/mp4',}]</script><template><div><VuePlayerclass="vue-player" :sources="sources"poster="..." @play="..."> // Your custom controls here</VuePlayer></div></template><stylescoped> .vue-player{width:100%;position:relative;height:fit-content;line-height:0;video{width:100%;height:auto;}}</style>
The library is easy to implement in any Nuxt project.Remember to wrap it on the<ClientOnly> component.
<scriptsetup>import{VuePlayer} from '@display-studio/vue-player'</script><template><ClientOnly><VuePlayerclass="vue-player" :sources="sources"poster="..." @play="..."> // Your custom controls here</VuePlayer></ClientOnly></template>
You can disable the native video tag controls and use your own custom ones.
App.vue
<scriptsetup>import{VuePlayer} from '@display-studio/vue-player'</script><template><div><VuePlayer :sources="..." :autoplay="true" :muted="true"> <!--useVuePlayer() within a VuePlayer instance --><MyControls/><MyPlayerDuration/><MyPlayerTrack/></VuePlayer></div></template>
MyControls.vue
<scriptsetup>import{useVuePlayer} from '@display-studio/vue-player'const{playing,togglePlay,toggleMute,videoMuted} = useVuePlayer()</script><template><divclass="vue-player__controls"><button @click="togglePlay()"class="vue-player__controls-toggleplay">{{playing ?"pause" :"play"}}</button><button @click="toggleMute()"class="vue-player__controls-togglemute">{{videoMuted ?"unmute" :"mute"}}</button></div></template><stylescoped>.vue-player__controls{position:absolute;bottom:0px;right:0px;display:flex;width:fit-content;gap:10px;padding:10px;}.vue-player__controls-toggleplay,.vue-player__controls-togglemute{flex:00auto;display:block;background-color:white;border:none;font-family:Arial,Helvetica,sans-serif;font-size:18px;text-transform:uppercase;border-radius:5px;padding:2px5px;}</style>
MyPlayerDuration.vue
<scriptsetuplang="ts">import{useVuePlayer} from '@display-studio/vue-player'const{convertTimeToDuration,time,duration} = useVuePlayer()</script><template><divclass="vue-player__timestamp"><divclass="vue-player__timestamp-inner"><pclass="vue-player__current-time">{{convertTimeToDuration(time)}}</p><pclass="vue-player__separator">/</p><pclass="vue-player__duration">{{convertTimeToDuration(duration)}}</p></div></div></template><stylescoped>.vue-player__timestamp{flex:2;text-align:center;position:absolute;bottom:0px;left:0px;padding:10px;}.vue-player__timestamp-inner{background-color:white;border-radius:5px;padding:2px5px;font-family:Arial,Helvetica,sans-serif;font-size:18px;user-select:none;p{display:inline-block;line-height:100%;}}.vue-player__current-time{color:royalblue;}.vue-player__separator{color:royalblue;}.vue-player__duration{font-weight:bold;color:black;}</style>
MyPlayerTrack.vue
<scriptsetuplang="ts">import{useVuePlayer} from '@display-studio/vue-player'const{percentagePlayed,seekToPercentage} = useVuePlayer()</script><template><divclass="vue-player__video-track"><inputtype="range"min="0"max="100"step="1" :value="percentagePlayed.toFixed(1)" @input="(e) => seekToPercentage(e.target.value)"/></div></template><stylescoped>.vue-player__video-track{padding:0010px;position:absolute;bottom:0px;left:50%;transform:translateX(-50%);width:50%;height:25px;display:flex;align-items:center;}.vue-player__video-track input[type="range"]{position:relative;overflow:hidden;width:100%;-webkit-appearance:none;background-color:white;border-radius:5px;color:black;}.vue-player__video-track input[type="range"]:focus{outline:none;}.vue-player__video-track input[type="range"]::-webkit-slider-runnable-track{height:6px;-webkit-appearance:none;color:black;}.vue-player__video-track input[type="range"]::-webkit-slider-thumb{width:6px;-webkit-appearance:none;height:6px;cursor:ew-resize;background:black;box-shadow:-245px00245pxblack;}</style>
| Name | Type | Description |
|---|---|---|
togglePlay | Function | Function to toggle play state |
playing | Boolean | Play state |
toggleMute | Function | Function to toggle mute state |
videoMuted | Boolean | Mute state |
time | Number | Current video time |
duration | Number | Video duration |
convertTimeToDuration | Function | Function to convert time |
percentagePlayed | Number | Percentage played |
seekToPercentage | Function | Function to set video current time based on clicked percentage |
openFullScreen | Function | Enable fullscreen |
togglePictureInPicture | Function | Enable PiP |
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
controls | Boolean | false | false | Enable native video controls |
loop | Boolean | false | false | Enable video loop |
width | Number | false | Video width | |
height | Number | false | Video height | |
autoplay | Boolean | false | false | Enable autoplay |
muted | Boolean | false | false | Mute video at the initialization |
poster | String | false | Source of the poster | |
preload | String | false | "auto" | Manage video loadingMDN |
sources | Array | false | Sources of the video | |
togglePlayOnClick | Boolean | false | Enable toggle play on click |
<template><VuePlayer :loop="true"/></VuePlayer></template>
We have chosen the following events, but they may change.
SeeMDN for more info.
| Event | Description |
|---|---|
play | Triggered when the video starts |
pause | Triggered when the video pause |
ended | Triggered when the video end |
loadeddata | The loadeddata event is fired when the frame at the current playback position of the media has finished loading; often the first frame. |
waiting | The waiting event is fired when playback has stopped because of a temporary lack of data. |
playing | The playing event is fired after playback is first started, and whenever it is restarted. For example, it is fired when playback resumes after having been paused or delayed due to a lack of data. |
timeupdate | The timeupdate event is fired when the time indicated by the currentTime attribute has been updated. |
canplay | The canplay event is fired when the user agent can play the media but estimates that not enough data has been loaded to play the media up to its end without having to stop for further buffering of content. |
canplaythrough | The canplaythrough event is fired when the user agent can play the media and estimates that enough data has been loaded to play the media up to its end without having to stop for further buffering of content. |
statechanged | Triggered when a state changed |
<scriptsetup> import{VuePlayer} from '@display-studio/vue-player' const myCustomFunction = ({event}) =>{console.log(event)}</script><template><VuePlayer @play="myCustomFunction"></VuePlayer></template>
About
Vue Video Player - Lightweight, customizable, and easy-to-implement vue video player.
Topics
Resources
License
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Uh oh!
There was an error while loading.Please reload this page.
Contributors2
Uh oh!
There was an error while loading.Please reload this page.