SpeedkitVimeo

We have integrated SpeedkitVimeo 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 SpeedkitPicture and preload the corresponding Vimeo 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 SpeedkitVimeo is used to initialise Vimeo videos with Vimeo Player-SDK.

The url of the Vimeo video must be specified.

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

Learn more about SpeedkitPicture

Example

<template>
  <div>
    <speedkit-vimeo v-bind="vimeo" @playing="onPlaying"  />
  </div>
</template>

<script>
import SpeedkitVimeo from 'nuxt-speedkit/components/SpeedkitVimeo';
export default {
  components: { SpeedkitVimeo },
  data () {
    return {
      vimeo: {
        url: '<vimeo-url>',
        title: 'Vimeo Title',
        loadingSpinner: undefined,
        options: {
          controls: false
        },
        posterSizes: {
          default: '100vw',
          md: '50vw'
        }
      }
    };
  },
  methods: {
    onPlaying () {
      console.log('Vimeo Player playing!');
    }
  }
};
</script>

Properties

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

url

• Type: String

Sets a video via the vimeo 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 SpeedkitHydrate or is only activated when entering the visible area.

mute

• Type: Boolean
  • Default: false

When set the player is muted.

posterLoadingSpinner

• Type: LoadingSpinner
  • Default: undefined

Sets a loading spinner definition of type LoadingSpinner, this describes the visual appearance of the loading state of the SpeedkitImage contained in the SpeedkitPicture.

posterSizes

• Type: String
  • Default: { default: '100vw', xxs: '100vw', xs: '100vw', sm: '100vw', md: '100vw', lg: '100vw', xl: '100vw', xxl: '100vw' }

Sets the image sizes of the poster.

Learn more about sizes

options

• Type: Object

Overrides the vimeo player options. These will be the same as the vimeo player embed options.

Learn more about Vimeo Player Parameters

Slots

<template #default="{ videoData }">
  {{videoData.title}}
</template>

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

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

Events

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