Skip to content

This enables lazy loading of YouTube videos with a customizable play button and smooth transitions, enhancing page load times and user experience.

License

Notifications You must be signed in to change notification settings

nexoscreator/lazy-youtube-player

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GitHub Pages GitHub Release GitHub License GitHub code size


Lazy YouTube Player 🎥

image

Lazy YouTube Player is a lightweight, customizable YouTube player. It provides a simple way to embed YouTube videos with lazy loading capabilities, improving your website's performance.


Features ✨

  • Lazy loading of YouTube videos using Intersection Observer API
  • TypeScript support for improved developer experience
  • Customizable player options (thumbnail, play button, etc.)
  • Accessibility improvements with ARIA attributes
  • Responsive design
  • Error handling for invalid video IDs or API failures

Installation 📦

<script type='module'
  src="https://cdn.jsdelivr.net/npm/lazy-youtube-player@v0.3.0/yt-player.min.js"
  defer
></script>

<link
  rel="stylesheet"
  href="https://cdn.jsdelivr.net/npm/lazy-youtube-player@v0.3.0/yt-player.min.css"
/>

Usage 🚀

Here's a basic example of how to use the Lazy YouTube Player in a website:

<div
  class="NexosYt"
  data-embed="YT_VIDEO_ID"
></div>

optional: data-thumbnail="CUSTOM_THUMBNAIL_URL"


Links 🔗

Web Demo GitHub Repo YouTube Video NPM Package


API

The LazyYouTubePlayer component accepts the following props:

  • NexosYT (string, required): The YouTube Player Class.
  • videoId (string, required): The YouTube video ID.
  • thumbnailUrl (string, optional): Custom thumbnail URL. If not provided, the default YouTube thumbnail will be used.
  • width (number, optional): The width of the player. Default: 640.
  • height (number, optional): The height of the player. Default: 360.

Contributing 🤝

We love contributions! Here's how you can help:

  1. 🍴 Fork the repository
  2. 🌿 Create your feature branch (git checkout -b feature/AmazingFeature)
  3. 💾 Commit your changes (git commit -m 'Add some AmazingFeature')
  4. 🚀 Push to the branch (git push origin feature/AmazingFeature)
  5. 🔃 Open a Pull Request

Check out our Contribution Guidelines for more details.


License 📄

This project is licensed under the MIT License - see the License file for details.


Created with ❤️ by @nexoscreator

⭐ Star us on GitHub!

About

This enables lazy loading of YouTube videos with a customizable play button and smooth transitions, enhancing page load times and user experience.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published