<lite-youtube>
A web component that renders YouTube embeds faster. The ShadowDom web component version of Paul's lite-youtube-embed.
Features
- No dependencies; it's just a vanilla web component.
- It's fast yo.
- It's Shadow Dom encapsulated!
- It's responsive 16:9
- It's accessible via keyboard and will set ARIA via the
videotitle
attribute - It's locale ready; you can set the
videoplay
to have a properly locale based label - Set the
start
attribute to start at a particular place in a video - You can set
autoload
to use Intersection Observer to load the iframe when scrolled into view. - Loads placeholder image as WebP with a Jpeg fallback
- new in v1.1: Adds
nocookie
attr for use with use youtube-nocookie.com as iframe embed uri - new in v1.2: Adds
playlistid
for playlist loading interface support - new in v1.3: Adds
loading=lazy
to image placeholder for more perf with posterloading
attr if you'd like to use eager - new in v1.4: Adds
short
attr for enabling experimental YouTube Shorts mobile interaction support. See (example video)[https://www.youtube.com/watch?v=aw7CRQTuRfo] for details. - new in v1.5: Adds support for nonce attribute via
window.liteYouTubeNonce
for CSP 2/3 support. - new in v1.6: Adds
autoPause
for pausing videos scrolled off screen; adds --lite-youtube-aspect-ratio
CSS custom property create custom aspect ratio videos; adds --lite-youtube-frame-shadow-visible
CSS custom property to disable frame shadow (flat look); adds a named slot image
that allows for setting custom poster image; adds credentialless
for COEP
Install via package manager
This web component is built with ES modules in mind and is
available on NPM:
To install, use your package manager of choice:
npm i @justinribeiro/lite-youtube
yarn add @justinribeiro/lite-youtube
After install, import into your project:
import '@justinribeiro/lite-youtube';
Install with CDN
If you want the paste-and-go version, you can simply load it via CDN:
<script type="module" src="https://cdn.jsdelivr.net/npm/@justinribeiro/lite-youtube@1/lite-youtube.min.js"></script>
Basic Usage
<lite-youtube videoid="guJLfqTFfIw"></lite-youtube>
Basic Usage with Fallback Link
A fallback appears in any of the following circumstances:
- Before the compontent is initialized
- When JS is disabled (like
<noscript>
) - When JS fails or the lite-youtube script is not loaded/executed
- When the browser doesn't support web components
<lite-youtube videoid="guJLfqTFfIw">
<a class="lite-youtube-fallback" href="https://www.youtube.com/watch?v=guJLfqTFfIw">Watch on YouTube: "Sample output of devtools-to-video cli tool"</a>
</lite-youtube>
Example CSS:
.lite-youtube-fallback {
aspect-ratio: 16 / 9;
display: flex;
justify-content: center;
align-items: center;
flex-direction: column;
gap: 1em;
padding: 1em;
background-color: #000;
color: #fff;
text-decoration: none;
}
.lite-youtube-fallback::before {
display: block;
content: '';
border: solid transparent;
border-width: 2em 0 2em 3em;
border-left-color: red;
}
.lite-youtube-fallback:hover::before {
border-left-color: #fff;
}
.lite-youtube-fallback:focus {
outline: 2px solid red;
}
Playlist Usage
Setting the YouTube playlistid allows the playlist interface to load on interaction. Note, this still requires a videoid for to load a placeholder thumbnail as YouTube does not return a thumbnail for playlists in the API.
<lite-youtube
videoid="VLrYOji75Vc"
playlistid="PL-G5r6j4GptH5JTveoLTVqpp7w2oc27Q9"
></lite-youtube>
Add Video Title
<lite-youtube
videotitle="This is a video title"
videoid="guJLfqTFfIw"
></lite-youtube>
Update interface for Locale
<lite-youtube
videoplay="Mirar"
videotitle="Mis hijos se burlan de mi español"
videoid="guJLfqTFfIw"
>
</lite-youtube>
Style It
Height and Width are responsive in the component.
<style>
.styleIt {
width: 400px;
margin: auto;
}
</style>
<div class="styleIt">
<lite-youtube videoid="guJLfqTFfIw"></lite-youtube>
</div>
Enable YouTube Shorts interaction on mobile
See the example video of how this feature works for additional details.
<lite-youtube videoid="vMImN9gghao" short></lite-youtube>
AutoLoad with IntersectionObserver
Uses Intersection Observer if available to automatically load the YouTube iframe when scrolled into view.
<lite-youtube videoid="guJLfqTFfIw" autoload> </lite-youtube>
Set a video start time
<lite-youtube videoid="guJLfqTFfIw" videoStartAt="5"></lite-youtube>
Fine tune the poster quality for a video
<lite-youtube
videoid="guJLfqTFfIw"
posterquality="maxresdefault"
></lite-youtube>
Use the named slot to set a custom poster image
<lite-youtube videoid="guJLfqTFfIw">
<img slot="image" src="my-poster-override.jpg">
</lite-youtube>
Set custom aspect ratio
<style>
lite-youtube {
--lite-youtube-aspect-ratio: 2 / 3;
}
</style>
<lite-youtube videoid="guJLfqTFfIw"></lite-youtube>
Disable the frame shadow (flat look)
<style>
lite-youtube {
--lite-youtube-frame-shadow-visible: no;
}
</style>
<lite-youtube videoid="guJLfqTFfIw"></lite-youtube>
Auto-Pause video when scrolled out of view
<lite-youtube videoid="VLrYOji75Vc" autopause></lite-youtube>
YouTube QueryParams
Use any YouTube Embedded Players and Player Parameters you like.
Note: the exception to this rule is the autoplay param; because of the nature of the performance loading and the inconsistency of usage, that parameter generally does not work. See this comment for details.
<lite-youtube videoid="guJLfqTFfIw" params="controls=0&enablejsapi=1">
</lite-youtube>
Attributes
The web component allows certain attributes to be give a little additional
flexibility.
Name | Description | Default |
---|
videoid | The YouTube videoid | `` |
playlistid | The YouTube playlistid; requires a videoid for thumbnail | `` |
videotitle | The title of the video | Video |
videoplay | The title of the play button (for translation) | Play |
videoStartAt | Set the point at which the video should start, in seconds | 0 |
posterquality | Set thumbnail poster quality (maxresdefault, sddefault, mqdefault, hqdefault) | hqdefault |
posterloading | Set img lazy load attr loading for poster image | lazy |
nocookie | Use youtube-nocookie.com as iframe embed uri | false |
autoload | Use Intersection Observer to load iframe when scrolled into view | false |
short | Show 9:16 YouTube Shorts-style interaction on mobile devices | false |
params | Set YouTube query parameters | `` |
Events
The web component fires events to give the ability understand important lifecycle.
Event Name | Description | Returns |
---|
liteYoutubeIframeLoaded | When the iframe is loaded, allowing us of JS API | detail: { videoId: this.videoId } |