vue-playr
v0.0.1 - Changelog
A vue component for the plyr video & audio player.
This is useful for when you want a nice video player in your Vue app.
It uses plyr by sampotts v3 for the players.
Supported player types: HTML5 video, HTML5 audio, YouTube (div & progressive enhancement), and Vimeo (div & progressive enhancement).
Installation
yarn add vue-playr plyr # or npm i vue-playr plyr
Module
// In your main vue file - the one where you create the initial vue instance. // The second argument is optional and sets the default config values for every player.Vue
(more below)
SSRFor SSR you can import the SSR optimized module, found at ./dist/vue-playr.ssr.js
.
There is a more in depth description on how to use it with nuxt below.
Browser
In the browser you can include it as you would any other package: with unpkg.
<!-- You will also need to install the component during app creation -->
Usage
Once installed, it can be used in a template as simply as:
<!-- video element --><vue-playr> <video poster="poster.png" src="video.mp4"> <source src="video-720p.mp4" type="video/mp4" size="720"> <source src="video-1080p.mp4" type="video/mp4" size="1080"> <track kind="captions" label="English" srclang="en" src="captions-en.vtt" default> </video></vue-playr> <!-- audio element --><vue-playr> <audio> <source src="audio.mp3" type="audio/mp3"/> <source src="audio.ogg" type="audio/ogg"/> </audio></vue-playr> <!-- youtube iframe with progressive enhancement (extra queries after the url to optimize the embed) --><vue-playr> <div class="plyr__video-embed"> <iframe src="https://www.youtube.com/embed/bTqVqk7FSmY?iv_load_policy=3&modestbranding=1&playsinline=1&showinfo=0&rel=0&enablejsapi=1" allowfullscreen allowtransparency allow="autoplay"> </iframe> </div></vue-playr> <!-- youtube div element --><vue-playr> <div data-plyr-provider="youtube" data-plyr-embed-id="bTqVqk7FSmY"></div></vue-playr> <!-- vimeo iframe with progressive enhancement (extra queries after the url to optimize the embed) --><vue-playr> <div class="plyr__video-embed"> <iframe src="https://player.vimeo.com/video/76979871?loop=false&byline=false&portrait=false&title=false&speed=true&transparent=0&gesture=media" allowfullscreen allowtransparency allow="autoplay"> </iframe> </div> </vue-playr> <!-- vimeo div element --><vue-playr> <div data-plyr-provider="vimeo" data-plyr-embed-id="76979871"></div></vue-playr>
Player Instance
To access the player instance, you can use the refs
attribute.
Events
If you want to capture events from the plyr instance, there are a few options:
The preferred method is accessing the player instance through the ref
attribute and using that object for events, as you would with a vanilla
plyr instance.
Valid events are here.
The other way is to just pass an array of the events you want emitted.
Options
For custom options you can pass an options
prop which is an object
that will be passed to the new Plyr()
creation. Available options
here. I added an additional
option (hideYouTubeDOMError
) that hides the error that is always
logged when destroying a YouTube player. It defaults to true
, and you
can disable it and see the error by setting it to false.
SSR
Nuxt
This should support SSR out of the box. For nuxt, create a file called vue-playr.js
in your plugins folder containing
only these three statements:
// The second argument is optional and sets the default config values for every player.Vue
Then, in your nuxt.config.js
file add '~/plugins/vue-playr'
to the plugins array. The vue-playr
element should be globally registered now.
You will also want to add plyr/dist/plyr.css
to your css array in the same file.
The nuxt.config.js
file should at minimum include this:
plugins: '~/plugins/vue-playr' css: 'plyr/dist/plyr.css'