diff --git a/website_youtube_lite/README.rst b/website_youtube_lite/README.rst new file mode 100644 index 0000000000..1ede127631 --- /dev/null +++ b/website_youtube_lite/README.rst @@ -0,0 +1,79 @@ +========================== +Website Youtube Lite Style +========================== + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:5ed8f6e68d496b67d0cb58f014486b8afbe892ea74f76f1f09b20f739ec4ef51 + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png + :target: https://odoo-community.org/page/development-status + :alt: Beta +.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html + :alt: License: AGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fwebsite-lightgray.png?logo=github + :target: https://github.com/OCA/website/tree/18.0/website_youtube_lite + :alt: OCA/website +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/website-18-0/website-18-0-website_youtube_lite + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png + :target: https://runboat.odoo-community.org/builds?repo=OCA/website&target_branch=18.0 + :alt: Try me on Runboat + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module allows to use the ``lite-youtube`` tag in place of standard +iframe. + +See: https://github.com/paulirish/lite-youtube-embed + +**Table of contents** + +.. contents:: + :local: + +Bug Tracker +=========== + +Bugs are tracked on `GitHub Issues `_. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us to smash it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +------- + +* ACSONE SA/NV + +Contributors +------------ + +- Denis Roussel denis.roussel@acsone.eu + +Maintainers +----------- + +This module is maintained by the OCA. + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use. + +This module is part of the `OCA/website `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/website_youtube_lite/__init__.py b/website_youtube_lite/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/website_youtube_lite/__manifest__.py b/website_youtube_lite/__manifest__.py new file mode 100644 index 0000000000..eea69dda40 --- /dev/null +++ b/website_youtube_lite/__manifest__.py @@ -0,0 +1,18 @@ +# Copyright 2026 ACSONE SA/NV +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +{ + "name": "Website Youtube Lite Style", + "summary": """This module allows to use youtube-lite tag""", + "version": "18.0.1.0.0", + "license": "AGPL-3", + "author": "ACSONE SA/NV,Odoo Community Association (OCA)", + "website": "https://github.com/OCA/website", + "depends": ["website"], + "assets": { + "web.assets_frontend": [ + "website_youtube_lite_style/static/src/js/lite-yt-embed.js", + "website_youtube_lite_style/static/src/css/lite-yt-embed.css", + ] + }, +} diff --git a/website_youtube_lite/pyproject.toml b/website_youtube_lite/pyproject.toml new file mode 100644 index 0000000000..4231d0cccb --- /dev/null +++ b/website_youtube_lite/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["whool"] +build-backend = "whool.buildapi" diff --git a/website_youtube_lite/readme/CONTRIBUTORS.md b/website_youtube_lite/readme/CONTRIBUTORS.md new file mode 100644 index 0000000000..4e7e684726 --- /dev/null +++ b/website_youtube_lite/readme/CONTRIBUTORS.md @@ -0,0 +1 @@ +- Denis Roussel diff --git a/website_youtube_lite/readme/DESCRIPTION.md b/website_youtube_lite/readme/DESCRIPTION.md new file mode 100644 index 0000000000..2d24309b53 --- /dev/null +++ b/website_youtube_lite/readme/DESCRIPTION.md @@ -0,0 +1,3 @@ +This module allows to use the `lite-youtube` tag in place of standard iframe. + +See: https://github.com/paulirish/lite-youtube-embed diff --git a/website_youtube_lite/static/description/icon.png b/website_youtube_lite/static/description/icon.png new file mode 100644 index 0000000000..3a0328b516 Binary files /dev/null and b/website_youtube_lite/static/description/icon.png differ diff --git a/website_youtube_lite/static/description/index.html b/website_youtube_lite/static/description/index.html new file mode 100644 index 0000000000..233b32573d --- /dev/null +++ b/website_youtube_lite/static/description/index.html @@ -0,0 +1,425 @@ + + + + + +Website Youtube Lite Style + + + +
+

Website Youtube Lite Style

+ + +

Beta License: AGPL-3 OCA/website Translate me on Weblate Try me on Runboat

+

This module allows to use the lite-youtube tag in place of standard +iframe.

+

See: https://github.com/paulirish/lite-youtube-embed

+

Table of contents

+ +
+

Bug Tracker

+

Bugs are tracked on GitHub Issues. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us to smash it by providing a detailed and welcomed +feedback.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • ACSONE SA/NV
    • +
+
+
+

Contributors

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+ +Odoo Community Association + +

OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use.

+

This module is part of the OCA/website project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ + diff --git a/website_youtube_lite/static/src/css/lite-yt-embed.css b/website_youtube_lite/static/src/css/lite-yt-embed.css new file mode 100644 index 0000000000..6c4e466431 --- /dev/null +++ b/website_youtube_lite/static/src/css/lite-yt-embed.css @@ -0,0 +1,102 @@ +lite-youtube { + background-color: #000; + position: relative; + display: block; + contain: content; + background-position: center center; + background-size: cover; + cursor: pointer; + max-width: 720px; +} + +/* gradient */ +lite-youtube::before { + content: attr(data-title); + display: block; + position: absolute; + top: 0; + /* Pixel-perfect port of YT's gradient PNG, using https://github.com/bluesmoon/pngtocss plus optimizations */ + background-image: linear-gradient( + 180deg, + rgb(0 0 0 / 67%) 0%, + rgb(0 0 0 / 54%) 14%, + rgb(0 0 0 / 15%) 54%, + rgb(0 0 0 / 5%) 72%, + rgb(0 0 0 / 0%) 94% + ); + height: 99px; + width: 100%; + font-family: "YouTube Noto", Roboto, Arial, Helvetica, sans-serif; + color: hsl(0deg 0% 93.33%); + text-shadow: 0 0 2px rgba(0, 0, 0, 0.5); + font-size: 18px; + padding: 25px 20px; + overflow: hidden; + white-space: nowrap; + text-overflow: ellipsis; + box-sizing: border-box; +} + +lite-youtube:hover::before { + color: white; +} + +/* responsive iframe with a 16:9 aspect ratio + thanks https://css-tricks.com/responsive-iframes/ +*/ +lite-youtube::after { + content: ""; + display: block; + padding-bottom: calc(100% / (16 / 9)); +} +lite-youtube > iframe { + width: 100%; + height: 100%; + position: absolute; + top: 0; + left: 0; + border: 0; +} + +/* play button */ +lite-youtube > .lyt-playbtn { + display: block; + /* Make the button element cover the whole area for a large hover/click target… */ + width: 100%; + height: 100%; + /* …but visually it's still the same size */ + background: no-repeat center/68px 48px; + /* YT's actual play button svg */ + background-image: url('data:image/svg+xml;utf8,'); + position: absolute; + cursor: pointer; + z-index: 1; + filter: grayscale(100%); + transition: filter 0.1s cubic-bezier(0, 0, 0.2, 1); + border: 0; +} + +lite-youtube:hover > .lyt-playbtn, +lite-youtube .lyt-playbtn:focus { + filter: none; +} + +/* Post-click styles */ +lite-youtube.lyt-activated { + cursor: unset; +} +lite-youtube.lyt-activated::before, +lite-youtube.lyt-activated > .lyt-playbtn { + opacity: 0; + pointer-events: none; +} + +.lyt-visually-hidden { + clip: rect(0 0 0 0); + clip-path: inset(50%); + height: 1px; + overflow: hidden; + position: absolute; + white-space: nowrap; + width: 1px; +} diff --git a/website_youtube_lite/static/src/js/lite-yt-embed.js b/website_youtube_lite/static/src/js/lite-yt-embed.js new file mode 100644 index 0000000000..2bcd1071d0 --- /dev/null +++ b/website_youtube_lite/static/src/js/lite-yt-embed.js @@ -0,0 +1,252 @@ +/** + * A lightweight youtube embed. Still should feel the same to the user, just MUCH faster to initialize and paint. + * + * Thx to these as the inspiration + * https://storage.googleapis.com/amp-vs-non-amp/youtube-lazy.html + * https://autoplay-youtube-player.glitch.me/ + * + * Once built it, I also found these: + * https://github.com/ampproject/amphtml/blob/master/extensions/amp-youtube (👍👍) + * https://github.com/Daugilas/lazyYT + * https://github.com/vb/lazyframe + */ + +/* eslint-disable */ + +class LiteYTEmbed extends HTMLElement { + connectedCallback() { + this.videoId = this.getAttribute("videoid"); + + let playBtnEl = this.querySelector(".lyt-playbtn,.lty-playbtn"); + // A label for the button takes priority over a [playlabel] attribute on the custom-element + this.playLabel = + (playBtnEl && playBtnEl.textContent.trim()) || + this.getAttribute("playlabel") || + "Play"; + + this.dataset.title = this.getAttribute("title") || ""; + + /** + * Lo, the youtube poster image! (aka the thumbnail, image placeholder, etc) + * + * See https://github.com/paulirish/lite-youtube-embed/blob/master/youtube-thumbnail-urls.md + */ + if (!this.style.backgroundImage) { + this.style.backgroundImage = `url("https://i.ytimg.com/vi/${this.videoId}/hqdefault.jpg")`; + this.upgradePosterImage(); + } + + // Set up play button, and its visually hidden label + if (!playBtnEl) { + playBtnEl = document.createElement("button"); + playBtnEl.type = "button"; + // Include the mispelled 'lty-' in case it's still being used. https://github.com/paulirish/lite-youtube-embed/issues/65 + playBtnEl.classList.add("lyt-playbtn", "lty-playbtn"); + this.append(playBtnEl); + } + if (!playBtnEl.textContent) { + const playBtnLabelEl = document.createElement("span"); + playBtnLabelEl.className = "lyt-visually-hidden"; + playBtnLabelEl.textContent = this.playLabel; + playBtnEl.append(playBtnLabelEl); + } + + this.addNoscriptIframe(); + + // for the PE pattern, change anchor's semantics to button + if (playBtnEl.nodeName === "A") { + playBtnEl.removeAttribute("href"); + playBtnEl.setAttribute("tabindex", "0"); + playBtnEl.setAttribute("role", "button"); + // fake button needs keyboard help + playBtnEl.addEventListener("keydown", (e) => { + if (e.key === "Enter" || e.key === " ") { + e.preventDefault(); + this.activate(); + } + }); + } + + // On hover (or tap), warm up the TCP connections we're (likely) about to use. + this.addEventListener("pointerover", LiteYTEmbed.warmConnections, {once: true}); + this.addEventListener("focusin", LiteYTEmbed.warmConnections, {once: true}); + + // Once the user clicks, add the real iframe and drop our play button + // TODO: In the future we could be like amp-youtube and silently swap in the iframe during idle time + // We'd want to only do this for in-viewport or near-viewport ones: https://github.com/ampproject/amphtml/pull/5003 + this.addEventListener("click", this.activate); + + // Chrome & Edge desktop have no problem with the basic YouTube Embed with ?autoplay=1 + // However Safari desktop and most/all mobile browsers do not successfully track the user gesture of clicking through the creation/loading of the iframe, + // so they don't autoplay automatically. Instead we must load an additional 2 sequential JS files (1KB + 165KB) (un-br) for the YT Player API + // TODO: Try loading the the YT API in parallel with our iframe and then attaching/playing it. #82 + this.needsYTApi = + this.hasAttribute("js-api") || + navigator.vendor.includes("Apple") || + navigator.userAgent.includes("Mobi"); + } + + /** + * Add a to the head + */ + static addPrefetch(kind, url, as) { + const linkEl = document.createElement("link"); + linkEl.rel = kind; + linkEl.href = url; + if (as) { + linkEl.as = as; + } + document.head.append(linkEl); + } + + /** + * Begin pre-connecting to warm up the iframe load + * Since the embed's network requests load within its iframe, + * preload/prefetch'ing them outside the iframe will only cause double-downloads. + * So, the best we can do is warm up a few connections to origins that are in the critical path. + * + * Maybe `` would work, but it's unsupported: http://crbug.com/593267 + * But TBH, I don't think it'll happen soon with Site Isolation and split caches adding serious complexity. + */ + static warmConnections() { + if (LiteYTEmbed.preconnected) return; + + // The iframe document and most of its subresources come right off youtube.com + LiteYTEmbed.addPrefetch("preconnect", "https://www.youtube-nocookie.com"); + // The botguard script is fetched off from google.com + LiteYTEmbed.addPrefetch("preconnect", "https://www.google.com"); + + // Not certain if these ad related domains are in the critical path. Could verify with domain-specific throttling. + LiteYTEmbed.addPrefetch("preconnect", "https://googleads.g.doubleclick.net"); + LiteYTEmbed.addPrefetch("preconnect", "https://static.doubleclick.net"); + + LiteYTEmbed.preconnected = true; + } + + fetchYTPlayerApi() { + if (window.YT || (window.YT && window.YT.Player)) return; + + this.ytApiPromise = new Promise((res, rej) => { + var el = document.createElement("script"); + el.src = "https://www.youtube.com/iframe_api"; + el.async = true; + el.onload = (_) => { + YT.ready(res); + }; + el.onerror = rej; + this.append(el); + }); + } + + /** Return the YT Player API instance. (Public L-YT-E API) */ + async getYTPlayer() { + if (!this.playerPromise) { + await this.activate(); + } + + return this.playerPromise; + } + + async addYTPlayerIframe() { + this.fetchYTPlayerApi(); + await this.ytApiPromise; + + const videoPlaceholderEl = document.createElement("div"); + this.append(videoPlaceholderEl); + + const paramsObj = Object.fromEntries(this.getParams().entries()); + + this.playerPromise = new Promise((resolve) => { + let player = new YT.Player(videoPlaceholderEl, { + width: "100%", + videoId: this.videoId, + playerVars: paramsObj, + events: { + onReady: (event) => { + event.target.playVideo(); + resolve(player); + }, + }, + }); + }); + } + + // Add the iframe within