📺 React Lite YouTube Embed

A private by default, faster and cleaner YouTube embed component for React applications

[![TypeScript](https://badges.frapsoft.com/typescript/code/typescript.svg?v=101)](https://www.typescriptlang.org/) [![Version](https://img.shields.io/npm/v/react-lite-youtube-embed?label=latest%20version)](https://www.npmjs.com/package/react-lite-youtube-embed) ![Total Downloads](https://img.shields.io/npm/dt/react-lite-youtube-embed?color=%23FF0000&logo=npm) [![License](https://badgen.net/github/license/ibrahimcesar/react-lite-youtube-embed)](./LICENSE) ![GitHub issues by-label](https://img.shields.io/github/issues/ibrahimcesar/react-lite-youtube-embed/bug)

Developed in 🇧🇷 Brazil

Port of Paul Irish's [Lite YouTube Embed](https://github.com/paulirish/lite-youtube-embed) to a React Component. Provide videos with a supercharged focus on visual performance. The gain is not the same as the web component of the original implementation but saves some requests and gives you more control of the embed visual. An ["Adaptive Loading"](https://www.youtube.com/watch?v=puUPpVrIRkc) way to handle iframes for YouTube. [![iFrame example](_example_lite.gif)](https://main.d1vubvlhfep0xm.amplifyapp.com/) ## [View Demo](https://main.d1vubvlhfep0xm.amplifyapp.com/)

## 🔒 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: ```bash yarn add react-lite-youtube-embed ``` ```bash npm install react-lite-youtube-embed -S ``` ## 🕹️ Basic Usage ```javascript import React from "react"; import { render } from "react-dom"; import LiteYouTubeEmbed from 'react-lite-youtube-embed'; import 'react-lite-youtube-embed/dist/LiteYouTubeEmbed.css'; const App = () => (

); render(, document.getElementById("root")); ``` And that's it. ## 💎 Pro Usage ```javascript const App = () => (

); ``` ## 🧰 Bring Your Own Styles React Lite YouTube Embed comes with all original styles from Paul Irish's [Lite YouTube Embed](https://github.com/paulirish/lite-youtube-embed) but you can customize them as you wish passing as a props. ```javascript const App = () => (

); ``` ## 🤖 Controlling the player You can programmatically control the YouTube player via [YouTubes IFrame Player API](https://developers.google.com/youtube/iframe_api_reference). 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. ```jsx const App = () => ( const ytRef = useRef(null); const [isPlaying, setIsPlaying] = useState(false); return (

); }; ); ``` ## ⚠️ After version 1.0.0 - BREAKING CHANGES ⚠️ To play nice with new frameworks like [NextJS](https://nextjs.org/), 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

Show me the code!

```css .yt-lite { background-color: #000; position: relative; display: block; contain: content; background-position: center center; background-size: cover; cursor: pointer; } /* gradient */ .yt-lite::before { content: ''; display: block; position: absolute; top: 0; background-position: top; background-repeat: repeat-x; height: 60px; padding-bottom: 50px; width: 100%; transition: all 0.2s cubic-bezier(0, 0, 0.2, 1); } /* responsive iframe with a 16:9 aspect ratio thanks https://css-tricks.com/responsive-iframes/ */ .yt-lite::after { content: ""; display: block; padding-bottom: calc(100% / (16 / 9)); } .yt-lite > iframe { width: 100%; height: 100%; position: absolute; top: 0; left: 0; } /* play button */ .yt-lite > .lty-playbtn { width: 65px; height: 46px; z-index: 1; opacity: 0.8; border: none; 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"); transition: all 0.2s cubic-bezier(0, 0, 0.2, 1); } .yt-lite:hover > .lty-playbtn { opacity: 1; } /* play button triangle */ .yt-lite > .lty-playbtn:before { content: ''; border-style: solid; border-width: 11px 0 11px 19px; border-color: transparent transparent transparent #fff; } .yt-lite > .lty-playbtn, .yt-lite > .lty-playbtn:before { position: absolute; top: 50%; left: 50%; transform: translate3d(-50%, -50%, 0); } /* Post-click styles */ .yt-lite.lyt-activated { cursor: unset; } .yt-lite.lyt-activated::before, .yt-lite.lyt-activated > .lty-playbtn { opacity: 0; pointer-events: none; } ``` For example, for NextJS: ```jsx ```

### 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.

Show me the code!

```ts import 'react-lite-youtube-embed/dist/index.css'; ``` or in a *.css/scss etc: ```css @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. | Prop | Type | Description | |----------|:--------:|------------| | **id** | string | id of the video or playlist | | **title** | string | Here goes your video title. Always provide a title for iFrames: [https://dequeuniversity.com/tips/provide-iframe-titles](https://dequeuniversity.com/tips/provide-iframe-titles) Help the web be accessible ;) #a11y | | activeClass | string | Pass the string class for the active state | | adNetwork | boolean | Default: `false` To preconnect or not to doubleclick addresses called by YouTube iframe (the adnetwork from Google) | | announce | string | Default: `Watch`. This will added to the button announce to the final user as in `Clickable Watch, ${title}, button` , customize to match your own language #a11y #i18n | | aspectHeight | number | Default: `9`. Use this optional prop if you want a custom aspect-ratio. Please be aware of aspect height and width relation and also any custom CSS you are using. | | aspectWidth | number | Default: `16`. Use this optional prop if you want a custom aspect-ratio. Please be aware of aspect height and width relation and also any custom CSS you are using. | | cookie | boolean | Default: `false`. Connect to YouTube via the Privacy-Enhanced Mode using [https://www.youtube-nocookie.com](https://www.youtube-nocookie.com). You should opt-in to allow cookies| | enableJsApi | boolean | Default: `false`. If this is enabled, you can send messages to the iframe (e.g. access via the `ref` prop) to control the player programmatically. | | alwaysLoadIframe | boolean | Default: `false`. If this is enabled, the original YouTube iframe will always be loaded right away (this is bad for privacy). | | iframeClass | string | Pass the string class for the own iFrame | | muted | boolean | If the video has sound or not. Required autoplay `true` to work | | noCookie | boolean | `Deprecated` Default `false` _use option **cookie** to opt-in_| | onIframeAdded | function | Callback that will fired when iframe loads | | params | string | any params you want to pass to the URL in the iFrame. Two important points to notice: You need to add the params, we already setup for you, so you should write `start=1150` and not `?start=1150` or `&start=1150`. You can place more params but it will need to fully form: `start=1150&other=value&another=value`. First, when you share a YouTube url the param of time is `t`, but the embed needs `start`.| | playerClass | string | Pass the string class for the player, once you can customize it | | playlist | boolean | Use `true` when your id be from a playlist | | playlistCoverId | string | 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 possible | | poster | string. One of `default` `mqdefault` `hqdefault` `sddefault` `maxresdefault` | Defines the image size to call on first render as poster image. See: [https://stackoverflow.com/questions/2068344/how-do-i-get-a-youtube-video-thumbnail-from-the-youtube-api](https://stackoverflow.com/questions/2068344/how-do-i-get-a-youtube-video-thumbnail-from-the-youtube-api) | | rel | string | Default `preload`. allows for prefetch or preload of the link url | | thumbnail | string | Pass an optional image url to override the default poster and set a custom poster image | | webp | boolean | Default `false`. When set, uses the WebP format for poster images | | wrapperClass | string | Pass the string class that wraps the iFrame | | containerElement | string | Default `article`. Pass the element to be used for the container. | | style | object | Pass the style object to be used for the container, overriding any root styles. | ## 🙇‍♂️ Thanks - Paul Irish ([paulirish](https://github.com/paulirish)) for [Lite YouTube Embed](https://github.com/paulirish/lite-youtube-embed) - Addy Osmani ([addyosmani](https://github.com/addyosmani)) for the Adaptive Loading ideas - [All contributors](https://github.com/ibrahimcesar/react-lite-youtube-embed/graphs/contributors) ### 📝 Read more - [Why I made my open source React component private by default](https://ibrahimcesar.cloud/blog/why-i-made-my-open-source-react-component-private-by-default/) ### 🈺 TODO - [x] Add tests ## MIT License Copyright (c) 2021 — 2023 [Ibrahim Cesar](https://ibrahimcesar.cloud) 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.

Package	Téléchargements	Stars	Taille	Issues	Publication	Licence

react-lite-youtube-embed	50,838	307	48.5 kB	29	il y a 19 jours	MIT