paulirish/lite-youtube-embed

Lite YouTube Embed

Renders faster than a sneeze.

Provide videos with a supercharged focus on visual performance. This custom element renders just like the real thing but approximately 224× faster.

Demo: https://paulirish.github.io/lite-youtube-embed/

Comparison

Basic usage

Use the lite-youtube-embed npm package or download from this repo and use src/.

To use the custom element you will need to:

1. Include the stylesheet within your application
2. Include the script as well
3. Use the lite-youtube tag via HTML or JS.
4. Be happy that you're providing a better user experience to your visitors

<!-- Include the CSS & JS.. (This could be direct from the package or bundled) -->
<link rel="stylesheet" href="node_modules/lite-youtube-embed/src/lite-yt-embed.css" />

<script src="node_modules/lite-youtube-embed/src/lite-yt-embed.js"></script>

<!-- Use the element. You may use it before the lite-yt-embed JS is executed. -->
<lite-youtube videoid="goiWrNiaT0I" playlabel="Play: Crayon Physics Deluxe - Trailer HD"></lite-youtube>

Privacy note: lite-youtube uses youtube-nocookie.com instead of youtube.com in order to be more privacy friendly for end users.

Pro-usage: load w/ JS deferred (aka progressive enhancement)

Use this as your HTML, load the script asynchronously, and let the JS progressively enhance it.

<lite-youtube videoid="goiWrNiaT0I" style="background-image: url('https://i.ytimg.com/vi/goiWrNiaT0I/hqdefault.jpg');">
  <a href="https://youtube.com/watch?v=goiWrNiaT0I" class="lyt-playbtn" title="Play Video">
    <span class="lyt-visually-hidden">Play Video: Crayon Physics Deluxe - Trailer HD</span>
  </a>
</lite-youtube>

Demo: progressive enhancement

Custom poster image

If you want to provide a custom poster image, just set it as the background-image, and lite-yt will not overwrite it:

<lite-youtube videoid="goiWrNiaT0I" style="background-image: url('https://i.ytimg.com/vi/goiWrNiaT0I/hqdefault.jpg');"></lite-youtube>

Use poster-image-availability.html to determine what poster images are available for you.

Access the YouTube Iframe Player API

Use the js-api param: <lite-youtube videoid="goiWrNiaT0I" js-api>.. Then you can use IFrame Player API:

const player = await document.querySelector('lite-youtube').getYTPlayer();
player.seekTo(15); // jump to 15 seconds

Demo: Iframe Player API usage

Add a video title

If you want to display a title prior to loading the full embed, set the title attribute:

<lite-youtube videoid="goiWrNiaT0I" title="Crayon Physics Deluxe - Trailer HD"></lite-youtube>

Demo: visible title

Custom Player Parameters

YouTube supports a variety of player parameters to control the iframe's behavior and appearance. These may be applied by using the params attribute.

<!-- Example to show a video player without controls, starting at 10s in, ending at 20s,
     with modest branding *and* enabling the JS API -->
<lite-youtube videoid="goiWrNiaT0I" params="controls=0&start=10&end=30&modestbranding=2&rel=0&enablejsapi=1"></lite-youtube>

Note that lite-youtube uses autoplay=1 by default.

Demo: Custom player parameters

Other fast YouTube embeds

• <lite-youtube> using shadow DOM: justinribeiro/lite-youtube :+1:
• React port 1: ibrahimcesar/react-lite-youtube-embed
• React port 2: kylemocode/react-lite-yt-embed
• React wrapper: @next/third-parties
• Vue port: andrewvasilchuk/vue-lazy-youtube-video

Other third-party facades

• Lite Vimeo Embed: luwes/lite-vimeo-embed
• <lite-vimeo>: slightlyoff/lite-vimeo
• React Live Chat Loader (Intercom, Help Scout, Drift, Facebook Messenger): calibreapp/react-live-chat-loader
• Intercom chat facade: danielbachhuber/intercom-facade/