BoosterYoutube

We have integrated BoosterYoutube as an example to show how iFrame content must be integrated in a performance-optimized manner. For this purpose, a separate IntersectionObserver has been implemented, which detects a longer dwell time of the component in the viewport. The iFrame is initialized only after a positive detection. This prevents immense data from having to be loaded when simply scrolling through the page. So that no empty space is visible to the user, we use the functionality of the BoosterPicture and preload the corresponding Youtube poster in different renditions, so the illusion is perfect for the user and he does not notice anything of the optimized lazy load procedure.

Usage

The BoosterYoutubeis used to initialise Youtube videos with Youtube Iframe-API.

The Youtube Iframe-API is not part of nuxt-booster and will be loaded by an external script. Learn more

The url of the Youtube video must be specified.

The BoosterPicture is used for the poster, so the generation of the poster is automated, you can define the image sources with posterSources (What is posterSources?).

Learn more about BoosterPicture

WARNING

Important: For using BoosterYoutube do not disable @nuxt/image via disableNuxtImage.

Example

<template>
  <div>
    <booster-youtube
      v-bind="{ url, title, host, options, posterSources }"
      @playing="onPlaying"
    />
  </div>
</template>

<script setup lang="ts">
import BoosterYoutube from '#booster/components/BoosterYoutube.vue';
import { ref } from 'vue';

const url = ref('<youtube-url>');
const title = ref('Youtube Title');
const host = ref('https://www.youtube.com');
const options = ref({
  fs: false // use boolean instead of 0 or 1
});
const posterSources = ref([
  {
    src: undefined,
    media: 'all',
    sizes: {
      default: '100vw'
    }
  }
]);

const onPlaying = () => console.log('Youtube Player playing!');
</script>

Properties

{
  url: '<youtube-url>',
  title: 'Player Title',
  autoplay: false,
  mute: false,
  options: { … },
  posterSources: { … },
}

url

• Type: String

Sets a video via the youtube url.

title

• Type: String

Sets the title for the player iframe and poster.

autoplay

• Type: Boolean
  • Default: false

When set starts video in autoplay. It is required that the component is integrated via BoosterHydrate or is only activated when entering the visible area.

mute

• Type: Boolean
  • Default: false

When set the player is muted.

posterSources

• Type: Array
  • Default: [ { src: undefined, media: 'all', sizes: { default: '100vw' } } ]

Sets the image sources of the poster.

INFO

You can overwrite the poster src with your own.
The src property is optionally available for this purpose.

Learn more about sources

options

• Type: Object

Overrides the youtube player options. These will be the same as the youtube player parameters.

Use boolean values instead of integers (e.g. 0, 1).

Learn more about Youtube Player Parameters

WARNING

For autoplay and mute the component properties are used.

Option playsinline is always set, mute is set automatically for touch devices.
This is important for autoplay on mobile devices.

host

• Type: String
  • default: 'https://www.youtube-nocookie.com'

Sets the host for the player.

Slots

<template #loading-spinner>
  Loading…
</template>

<template #play>
  <span>Click!</span>
</template>

Name	Description
loading-spinner	Overwrites the loading spinner.
play	Overwrites the play button.

Events

<booster-youtube 
  @ready="console.log('Player Ready!')" 
  @playing="console.log('Player Playing!')" 
/>

Name	Description
ready	Triggered when Youtube-API is completely loaded.
playing	Triggered when video is finished loading and playing.
beforePlayer	Used to place elements in the player container (before).
afterPlayer	Used to place elements in the player container (after).