1.x documentation can be found here.

• vue-lazy-youtube-video
  • Features
  • Installation
    • Via NPM
    • Via Yarn
    • Directly in browser
  • Initialization
    • Styles
    • As a global component
    • As a local component
    • As a plugin
  • Usage
  • Demo
  • API
    • Properties
    • Events
    • Methods
    • Slots
    • FAQ
  • Tests
    • Unit
  • TypeScript support
  • Development
  • Build
  • Powered by
  • Inspiration
  • License

• reduces initial load size by ~1.1MB per video
• built with a11y in mind – fully accessible via keyboard and to screen readers
• .webp thumbnail format for modern browsers that support it, with .jpg fallback for browsers that don't
• fully customizable through props and slots

$ npm install vue-lazy-youtube-video --save

$ yarn add vue-lazy-youtube-video

<script src="https://cdn.jsdelivr.net/npm/vue"></script> <!-- Styles with CSS Custom Properties --> <link rel="stylesheet" href="https://unpkg.com/vue-lazy-youtube-video/dist/style.css"></link> <!-- Minified styles with CSS Custom Properties --> <!-- <link rel="stylesheet" href="https://unpkg.com/vue-lazy-youtube-video/dist/style.min.css"></link> --> <!-- Styles without CSS Custom Properties --> <!-- <link rel="stylesheet" href="https://unpkg.com/vue-lazy-youtube-video/dist/style.simplified.css"></link> --> <!-- Minified styles without CSS Custom Properties --> <!-- <link rel="stylesheet" href="https://unpkg.com/vue-lazy-youtube-video/dist/style.simplified.min.css"></link> --> <script src="https://unpkg.com/vue-lazy-youtube-video"></script> <script> // as a plugin Vue.use(VueLazyYoutubeVideo.Plugin) // as a component Vue.use('LazyYoutubeVideo', VueLazyYoutubeVideo.default) </script>

import 'vue-lazy-youtube-video/dist/style.css'

⚠️ It must be called before new Vue().

import Vue from 'vue' import LazyYoutubeVideo from 'vue-lazy-youtube-video' Vue.component('LazyYoutubeVideo', LazyYoutubeVideo)

import LazyYoutubeVideo from 'vue-lazy-youtube-video' export default { name: 'YourAwesomeComponent', components: { LazyYoutubeVideo, }, }

⚠️ It must be called before new Vue().

import Vue from 'vue' import { Plugin } from 'vue-lazy-youtube-video' Vue.use(Plugin)

<template> <LazyYoutubeVideo src="https://www.youtube.com/embed/4JS70KB9GS0" /> </template>

The list of available props (with their types, default values and descriptions) is listed below:

Component provides some slots.

The list of available slots is listed below:

⚠️ Note, that when button slot is passed and this slot contains <button></button>, ones should not to forget to add aria-label (if this button contains only icon) and type="button" attributes. Also, if that button do not contain .y-video-button class, all default styles will be lost, so style concerns it's up to developer.

Question: How to play/pause/stop a video?

Answer: Pass the enablejapi prop and then listen to 'init:player' event to get an instance of the YT.Player. All the available instance methods you can find here. Hint: You can also get a player instance via the getPlayerInstance method.

<LazyYoutubeVideo ref="youtube" src="..." enablejsapi @init:player="onPlayerInit" />

import { InitPlayerEventPayload } from 'vue-lazy-youtube-video' { // ... methods: { onPlayerInit(payload: InitPlayerEventPayload) { console.log(payload.instance) console.log(this.$refs.youtube.getPlayerInstance()) }, }, // ... }

You can run unit tests by running the next command:

npm run test

Jest is used for unit-tests.

Jest and VueTestUtils is used for unit tests.

You can run unit tests by running the next command:

npm run test:unit

Component is completely built and tested using TypeScript.

Here is the list of the types you can use:

// import type {} TypeScript 3.8 + import { Props, LoadIframeEventPayload, InitPlayerEventPayload, Thumbnail, } from 'vue-lazy-youtube-video'

1. Clone this repository
2. Install dependencies using yarn install or npm install
3. Start development server using npm run dev script

To build the production ready bundle simply run npm run build:

After the successful build the following files will be generated in the dist folder:

├── vue-lazy-youtube-video.common.js ├── vue-lazy-youtube-video.esm.js ├── vue-lazy-youtube-video.js ├── vue-lazy-youtube-video.min.js ├── style.css ├── style.min.css ├── style.simplified.css ├── style.simplified.min.css 

• Vue
• Rollup (and plugins)
• Babel
• Jest
• Vue Test Utils
• TypeScript
• PostCSS

Inspired by Vadim Makeev. Vadim created a comprehensive tutorial in which he shows how to lazyload YouTube videos properly.

MIT