🔒 Up 2.0.0 Privacy by Default

The biggest change is, from 2.0.0 this component is private by default. Meaning that will not preconnect with the ad network from Google and connect to YouTube via the Privacy-Enhanced Mode using https://www.youtube-nocookie.com.

🚀 Install

Use your favorite package manager:

1yarn add react-lite-youtube-embed

1npm install react-lite-youtube-embed -S

🕹️ Basic Usage

1import React from "react";
2import { render } from "react-dom";
3import LiteYouTubeEmbed from 'react-lite-youtube-embed';
4import 'react-lite-youtube-embed/dist/LiteYouTubeEmbed.css';
5
6const App = () => (
7  <div>
8    <LiteYouTubeEmbed
9        id="L2vS_050c-M"
10        title="What’s new in Material Design for the web (Chrome Dev Summit 2019)"
11    />
12  </div>
13);
14
15render(<App />, document.getElementById("root"));

And that's it.

💎 Pro Usage

1const App = () => (
2  <div>
3    <LiteYouTubeEmbed
4       id="L2vS_050c-M" // Default none, id of the video or playlist
5       adNetwork={false} // Default false, to preconnect or not to doubleclick addresses called by YouTube iframe (the adnetwork from Google)
6       params="" // any params you want to pass to the URL, assume we already had '&' and pass your parameters string
7       playlist={false} // Use true when your ID be from a playlist
8       playlistCoverId="L2vS_050c-M" // The ids for playlists did not bring the cover in a pattern to render so you'll need pick up a video from the playlist (or in fact, whatever id) and use to render the cover. There's a programmatic way to get the cover from YouTube API v3 but the aim of this component is do not make any another call and reduce requests and bandwidth usage as much as possibe
9       poster="hqdefault" // Defines the image size to call on first render as poster image. Possible values are "default","mqdefault",  "hqdefault", "sddefault" and "maxresdefault". Default value for this prop is "hqdefault". Please be aware that "sddefault" and "maxresdefault", high resolution images are not always avaialble for every video. See: https://stackoverflow.com/questions/2068344/how-do-i-get-a-youtube-video-thumbnail-from-the-youtube-api
10       title="YouTube Embed" // a11y, always provide a title for iFrames: https://dequeuniversity.com/tips/provide-iframe-titles Help the web be accessible ;)
11       cookie={false} // Default false, don't connect to YouTube via the Privacy-Enhanced Mode using https://www.youtube-nocookie.com
12       ref={myRef} // Use this ref prop to programmatically access the underlying iframe element. It will only have a value after the user pressed the play button
13    />
14  </div>
15);

🧰 Bring Your Own Styles

React Lite YouTube Embed comes with all original styles from Paul Irish's Lite YouTube Embed but you can customize them as you wish passing as a props.

1const App = () => (
2  <div>
3    <LiteYouTubeEmbed
4       id="L2vS_050c-M"
5       activeClass="lyt-activated" // Default as "lyt-activated", gives control to wrapper once clicked
6       iframeClass="" // Default none, gives control to add a class to iframe element itself
7       playerClass="lty-playbtn" // Default as "lty-playbtn" to control player button styles
8       wrapperClass="yt-lite" // Default as "yt-lite" for the div wrapping the area, the most important class and needs extra attention, please refer to LiteYouTubeEmbed.css for a reference.
9    />
10  </div>
11);

🤖 Controlling the player

You can programmatically control the YouTube player via YouTubes IFrame Player API. However typically YouTube requires you to load an additional script from their servers (https://www.youtube.com/iframe_api), which is small but it will load another script. So this is neither performant nor very privacy-friendly. Instead, you can also send messages to the iframe via (postMessage)[https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage] using the ref prop. If you don't want to create the postMessage() calls yourself, there is also a little (wrapper library)[https://github.com/mich418/youtube-iframe-ctrl] for controlling the iframe with this method.

[!WARNING]
This will only work if you set the enableJsApi prop to true. Also, the ref will only be defined, when the iframe has been loaded (which happens after clicking on the poster). So you can't start the player through this method. If you really want the player to always load the iframe right away (which is not good in terms of privacy), you can use the alwaysLoadIframe prop to do this.

1const App = () => (
2  const ytRef = useRef(null);
3  const [isPlaying, setIsPlaying] = useState(false);
4
5  return (
6    <div>
7      <button
8        onClick={() => {
9          setIsPlaying((oldState) => !oldState);
10          ytRef.current?.contentWindow?.postMessage(
11            `{"event": "command", "func": "${isPlaying ? "pauseVideo" : "playVideo"}"}`,
12            "*",
13          );
14        }}
15      >
16        External Play Button
17      </button>
18      <YouTubeNew
19        title="My Video"
20        id="L2vS_050c-M"
21        ref={ytRef}
22        enableJsApi
23        alwaysLoadIframe
24      />
25    </div>
26  );
27};
28);
29

⚠️ After version 1.0.0 - BREAKING CHANGES ⚠️

To play nice with new frameworks like NextJS, we now don't import the .css necessary. Since version 2.0.9 you can pass custom aspect-ratio props, so be aware of any changes needed in the CSS options. Instead use now you have three options:

Option 1

Place the necessary CSS in your Global CSS file method of preference

1.yt-lite {
2    background-color: #000;
3    position: relative;
4    display: block;
5    contain: content;
6    background-position: center center;
7    background-size: cover;
8    cursor: pointer;
9}
10
11/* gradient */
12.yt-lite::before {
13    content: '';
14    display: block;
15    position: absolute;
16    top: 0;
17    background-position: top;
18    background-repeat: repeat-x;
19    height: 60px;
20    padding-bottom: 50px;
21    width: 100%;
22    transition: all 0.2s cubic-bezier(0, 0, 0.2, 1);
23}
24
25/* responsive iframe with a 16:9 aspect ratio
26    thanks https://css-tricks.com/responsive-iframes/
27*/
28.yt-lite::after {
29    content: "";
30    display: block;
31    padding-bottom: calc(100% / (16 / 9));
32}
33.yt-lite > iframe {
34    width: 100%;
35    height: 100%;
36    position: absolute;
37    top: 0;
38    left: 0;
39}
40
41/* play button */
42.yt-lite > .lty-playbtn {
43    width: 65px;
44    height: 46px;
45    z-index: 1;
46    opacity: 0.8;
47    border: none;
48    background: url("data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%22%20xmlns%3Axlink%3D%22http%3A%2F%2Fwww.w3.org%2F1999%2Fxlink%22%20version%3D%221.1%22%20id%3D%22YouTube_Icon%22%20x%3D%220px%22%20y%3D%220px%22%20viewBox%3D%220%200%201024%20721%22%20enable-background%3D%22new%200%200%201024%20721%22%20xml%3Aspace%3D%22preserve%22%3E%3Cscript%20xmlns%3D%22%22%3E%0A%20%20%20%20try%20%7B%0A%20%20%20%20%20%20Object.defineProperty(navigator%2C%20%22globalPrivacyControl%22%2C%20%7B%0A%20%20%20%20%20%20%20%20value%3A%20false%2C%0A%20%20%20%20%20%20%20%20configurable%3A%20false%2C%0A%20%20%20%20%20%20%20%20writable%3A%20false%0A%20%20%20%20%20%20%7D)%3B%0A%20%20%20%20%20%20document.currentScript.parentElement.removeChild(document.currentScript)%3B%0A%20%20%20%20%7D%20catch(e)%20%7B%7D%3B%0A%20%20%20%20%20%20%3C%2Fscript%3E%0A%3Cpath%20id%3D%22Triangle%22%20fill%3D%22%23FFFFFF%22%20d%3D%22M407%2C493l276-143L407%2C206V493z%22%2F%3E%0A%3Cpath%20id%3D%22The_Sharpness%22%20opacity%3D%220.12%22%20fill%3D%22%23420000%22%20d%3D%22M407%2C206l242%2C161.6l34-17.6L407%2C206z%22%2F%3E%0A%3Cg%20id%3D%22Lozenge%22%3E%0A%09%3Cg%3E%0A%09%09%0A%09%09%09%3ClinearGradient%20id%3D%22SVGID_1_%22%20gradientUnits%3D%22userSpaceOnUse%22%20x1%3D%22512.5%22%20y1%3D%22719.7%22%20x2%3D%22512.5%22%20y2%3D%221.2%22%20gradientTransform%3D%22matrix(1%200%200%20-1%200%20721)%22%3E%0A%09%09%09%3Cstop%20offset%3D%220%22%20style%3D%22stop-color%3A%23E52D27%22%2F%3E%0A%09%09%09%3Cstop%20offset%3D%221%22%20style%3D%22stop-color%3A%23BF171D%22%2F%3E%0A%09%09%3C%2FlinearGradient%3E%0A%09%09%3Cpath%20fill%3D%22url(%23SVGID_1_)%22%20d%3D%22M1013%2C156.3c0%2C0-10-70.4-40.6-101.4C933.6%2C14.2%2C890%2C14%2C870.1%2C11.6C727.1%2C1.3%2C512.7%2C1.3%2C512.7%2C1.3%20%20%20%20h-0.4c0%2C0-214.4%2C0-357.4%2C10.3C135%2C14%2C91.4%2C14.2%2C52.6%2C54.9C22%2C85.9%2C12%2C156.3%2C12%2C156.3S1.8%2C238.9%2C1.8%2C321.6v77.5%20%20%20%20C1.8%2C481.8%2C12%2C564.4%2C12%2C564.4s10%2C70.4%2C40.6%2C101.4c38.9%2C40.7%2C89.9%2C39.4%2C112.6%2C43.7c81.7%2C7.8%2C347.3%2C10.3%2C347.3%2C10.3%20%20%20%20s214.6-0.3%2C357.6-10.7c20-2.4%2C63.5-2.6%2C102.3-43.3c30.6-31%2C40.6-101.4%2C40.6-101.4s10.2-82.7%2C10.2-165.3v-77.5%20%20%20%20C1023.2%2C238.9%2C1013%2C156.3%2C1013%2C156.3z%20M407%2C493V206l276%2C144L407%2C493z%22%2F%3E%0A%09%3C%2Fg%3E%0A%3C%2Fg%3E%0A%3C%2Fsvg%3E");
49    transition: all 0.2s cubic-bezier(0, 0, 0.2, 1);
50}
51.yt-lite:hover > .lty-playbtn {
52    opacity: 1;
53}
54/* play button triangle */
55.yt-lite > .lty-playbtn:before {
56    content: '';
57    border-style: solid;
58    border-width: 11px 0 11px 19px;
59    border-color: transparent transparent transparent #fff;
60}
61
62.yt-lite > .lty-playbtn,
63.yt-lite > .lty-playbtn:before {
64    position: absolute;
65    top: 50%;
66    left: 50%;
67    transform: translate3d(-50%, -50%, 0);
68}
69
70/* Post-click styles */
71.yt-lite.lyt-activated {
72    cursor: unset;
73}
74.yt-lite.lyt-activated::before,
75.yt-lite.lyt-activated > .lty-playbtn {
76    opacity: 0;
77    pointer-events: none;
78}

1<style jsx global>{`
2        html,
3        body {
4          padding: 0;
5          margin: 0;
6          font-family: -apple-system, BlinkMacSystemFont, Segoe UI, Roboto,
7            Oxygen, Ubuntu, Cantarell, Fira Sans, Droid Sans, Helvetica Neue,
8            sans-serif;
9        }
10
11        * {
12          box-sizing: border-box;
13
14        // CSS above
15
16`}</style>
17

Option 2

Using your CSS-In-JS tool of choice encapsulate this component and use the css provided as a guide.

Option 3

Not work on every framework but you can import the css directly, check what works best with your bundler / framework.

1import 'react-lite-youtube-embed/dist/index.css';

1@import "~react-lite-youtube-embed/dist/index.css";

All our props belongs to you

The most minimalist implementation requires two props: id from the YouTube you want to render and title, for the iFrame.

🙇‍♂️ Thanks

• Paul Irish (paulirish) for Lite YouTube Embed
• Addy Osmani (addyosmani) for the Adaptive Loading ideas
• All contributors

📝 Read more

• Why I made my open source React component private by default

🈺 TODO

• Add tests

MIT License

Copyright (c) 2021 — 2023 Ibrahim Cesar

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.