UNPKG

vlitejs

Version:

vLitejs is a fast and lightweight Javascript library for customizing HTML5 and Youtube video players in Javascript with a minimalist theme

581 lines (351 loc) 18.4 kB
<!doctype html> <html lang="en" class="no-js"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width,initial-scale=1"> <meta http-equiv="x-ua-compatible" content="ie=edge"> <meta name="description" content="vLitejs is a fast and lightweight Javascript library for customizing HTML5 and Youtube video players in Javascript with a minimalist theme"> <link rel="canonical" href="https://yoriiis.github.io/vlitejs/index.html"> <meta name="author" content="Joris DANIEL aka Yoriiis"> <meta name="lang:clipboard.copy" content="Copy to clipboard"> <meta name="lang:clipboard.copied" content="Copied to clipboard"> <meta name="lang:search.language" content="en"> <meta name="lang:search.pipeline.stopwords" content="True"> <meta name="lang:search.pipeline.trimmer" content="True"> <meta name="lang:search.result.none" content="No matching documents"> <meta name="lang:search.result.one" content="1 matching document"> <meta name="lang:search.result.other" content="# matching documents"> <meta name="lang:search.tokenizer" content="[\s\-]+"> <link rel="shortcut icon" href="images/vlitejs-favicon.png"> <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.4.3"> <title>vLitejs</title> <link rel="stylesheet" href="assets/stylesheets/application.30686662.css"> <link rel="stylesheet" href="assets/stylesheets/application-palette.a8b3c06d.css"> <meta name="theme-color" content=""> <script src="assets/javascripts/modernizr.74668098.js"></script> <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin> <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Ubuntu+Mono&display=fallback"> <style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Ubuntu Mono","Courier New",Courier,monospace}</style> <link rel="stylesheet" href="assets/fonts/material-icons.css"> <script> window.ga = window.ga || function() { (ga.q = ga.q || []).push(arguments) } ga.l = +new Date /* Setup integration and send page view */ ga("create", "UA-108758282-2", "auto") ga("set", "anonymizeIp", true) ga("send", "pageview") /* Register handler to log search on blur */ document.addEventListener("DOMContentLoaded", () => { if (document.forms.search) { var query = document.forms.search.query query.addEventListener("blur", function() { if (this.value) { var path = document.location.pathname; ga("send", "pageview", path + "?q=" + this.value) } }) } }) </script> <script async src="https://www.google-analytics.com/analytics.js"></script> <meta property="og:title" content="vLitejs" /> <meta property="og:description" content="vLitejs is a fast and lightweight Javascript library for customizing HTML5 and Youtube video players in Javascript with a minimalist theme" /> <meta property="og:type" content="website" /> <meta property="og:url" content="https://yoriiis.github.io/vlitejs/" /> <meta property="og:image" content="https://yoriiis.github.io/vlitejs/assets/images/vlitejs.jpg" /> <link rel="stylesheet" type="text/css" href="https://yoriiis.github.io/vlitejs/assets/stylesheets/override.css" /> <meta property="og:image:width" content="1200" /> <meta property="og:image:height" content="630" /> </head> <body dir="ltr" data-md-color-primary="white" data-md-color-accent="white"> <svg class="md-svg"> <defs> <svg xmlns="http://www.w3.org/2000/svg" width="416" height="448" viewBox="0 0 416 448" id="__github"><path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19T128 352t-18.125-8.5-10.75-19T96 304t3.125-20.5 10.75-19T128 256t18.125 8.5 10.75 19T160 304zm160 0q0 10-3.125 20.5t-10.75 19T288 352t-18.125-8.5-10.75-19T256 304t3.125-20.5 10.75-19T288 256t18.125 8.5 10.75 19T320 304zm40 0q0-30-17.25-51T296 232q-10.25 0-48.75 5.25Q229.5 240 208 240t-39.25-2.75Q130.75 232 120 232q-29.5 0-46.75 21T56 304q0 22 8 38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 37.25-1.75t35-7.375 30.5-15 20.25-25.75T360 304zm56-44q0 51.75-15.25 82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5T212 416q-19.5 0-35.5-.75t-36.875-3.125-38.125-7.5-34.25-12.875T37 371.5t-21.5-28.75Q0 312 0 260q0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 30.875Q171.5 96 212 96q37 0 70 8 26.25-20.5 46.75-30.25T376 64q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 99.5z"/></svg> </defs> </svg> <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off"> <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off"> <label class="md-overlay" data-md-component="overlay" for="__drawer"></label> <a href="#the-new-smallest-javascript-video-library" tabindex="1" class="md-skip"> Skip to content </a> <header class="md-header" data-md-component="header"> <nav class="md-header-nav md-grid"> <div class="md-flex"> <div class="md-flex__cell md-flex__cell--shrink"> <a href="https://yoriiis.github.io/vlitejs/" title="vLitejs" class="md-header-nav__button md-logo"> <img src="images/logo-vlite-small.svg" width="24" height="24"> </a> </div> <div class="md-flex__cell md-flex__cell--shrink"> <label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label> </div> <div class="md-flex__cell md-flex__cell--stretch"> <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title"> <span class="md-header-nav__topic"> vLitejs </span> <span class="md-header-nav__topic"> Overview </span> </div> </div> <div class="md-flex__cell md-flex__cell--shrink"> <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label> <div class="md-search" data-md-component="search" role="dialog"> <label class="md-search__overlay" for="__search"></label> <div class="md-search__inner" role="search"> <form class="md-search__form" name="search"> <input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active"> <label class="md-icon md-search__icon" for="__search"></label> <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1"> &#xE5CD; </button> </form> <div class="md-search__output"> <div class="md-search__scrollwrap" data-md-scrollfix> <div class="md-search-result" data-md-component="result"> <div class="md-search-result__meta"> Type to start searching </div> <ol class="md-search-result__list"></ol> </div> </div> </div> </div> </div> </div> <div class="md-flex__cell md-flex__cell--shrink"> <div class="md-header-nav__source"> <a href="https://github.com/yoriiis/vlitejs/" title="Go to repository" class="md-source" data-md-source="github"> <div class="md-source__icon"> <svg viewBox="0 0 24 24" width="24" height="24"> <use xlink:href="#__github" width="24" height="24"></use> </svg> </div> <div class="md-source__repository"> yoriiis/vlitejs </div> </a> </div> </div> </div> </nav> </header> <div class="md-container"> <main class="md-main" role="main"> <div class="md-main__inner md-grid" data-md-component="container"> <div class="md-sidebar md-sidebar--primary" data-md-component="navigation"> <div class="md-sidebar__scrollwrap"> <div class="md-sidebar__inner"> <nav class="md-nav md-nav--primary" data-md-level="0"> <label class="md-nav__title md-nav__title--site" for="__drawer"> <a href="https://yoriiis.github.io/vlitejs/" title="vLitejs" class="md-nav__button md-logo"> <img src="images/logo-vlite-small.svg" width="48" height="48"> </a> vLitejs </label> <div class="md-nav__source"> <a href="https://github.com/yoriiis/vlitejs/" title="Go to repository" class="md-source" data-md-source="github"> <div class="md-source__icon"> <svg viewBox="0 0 24 24" width="24" height="24"> <use xlink:href="#__github" width="24" height="24"></use> </svg> </div> <div class="md-source__repository"> yoriiis/vlitejs </div> </a> </div> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item md-nav__item--active"> <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc"> <label class="md-nav__link md-nav__link--active" for="__toc"> Overview </label> <a href="index.html" title="Overview" class="md-nav__link md-nav__link--active"> Overview </a> <nav class="md-nav md-nav--secondary"> <label class="md-nav__title" for="__toc">Table of contents</label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="#philosophy" class="md-nav__link"> Philosophy </a> </li> <li class="md-nav__item"> <a href="#github-npm" class="md-nav__link"> Github &amp; npm </a> </li> <li class="md-nav__item"> <a href="#browsers-support" class="md-nav__link"> Browsers support </a> </li> <li class="md-nav__item"> <a href="#licence" class="md-nav__link"> Licence </a> </li> <li class="md-nav__item"> <a href="#contributors" class="md-nav__link"> Contributors </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="getting-started.html" title="Getting started" class="md-nav__link"> Getting started </a> </li> <li class="md-nav__item"> <a href="how-it-works.html" title="How it works" class="md-nav__link"> How it works </a> </li> <li class="md-nav__item"> <a href="available-methods.html" title="Available methods" class="md-nav__link"> Available methods </a> </li> <li class="md-nav__item"> <a href="demo.html" title="Demo" class="md-nav__link"> Demo </a> </li> <li class="md-nav__item"> <a href="download.html" title="Download" class="md-nav__link"> Download </a> </li> </ul> </nav> </div> </div> </div> <div class="md-sidebar md-sidebar--secondary" data-md-component="toc"> <div class="md-sidebar__scrollwrap"> <div class="md-sidebar__inner"> <nav class="md-nav md-nav--secondary"> <label class="md-nav__title" for="__toc">Table of contents</label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="#philosophy" class="md-nav__link"> Philosophy </a> </li> <li class="md-nav__item"> <a href="#github-npm" class="md-nav__link"> Github &amp; npm </a> </li> <li class="md-nav__item"> <a href="#browsers-support" class="md-nav__link"> Browsers support </a> </li> <li class="md-nav__item"> <a href="#licence" class="md-nav__link"> Licence </a> </li> <li class="md-nav__item"> <a href="#contributors" class="md-nav__link"> Contributors </a> </li> </ul> </nav> </div> </div> </div> <div class="md-content"> <article class="md-content__inner md-typeset"> <a href="https://github.com/yoriiis/vlitejs/edit/master/docs/index.md" title="Edit this page" class="md-icon md-content__icon">&#xE3C9;</a> <p><br /><p align="center" class="logo-vlite"> <img alt="Screenshot" src="images/logo-vlite.svg" /> </p><br /></p> <h1 id="the-new-smallest-javascript-video-library">The new smallest Javascript video library<a class="headerlink" href="#the-new-smallest-javascript-video-library" title="Permanent link">&para;</a></h1> <p>vLitejs is a <strong>fast</strong> and <strong>lightweight</strong> Javascript library to customize and skin native HTML5 video and Youtube video. Only <strong>5Kb</strong> on production with gzip, vLitejs has no dependency with any framework or library and is written in <strong>Javascript native</strong>.<br /></p> <p><br /><p align="center" class="video-center"> <a href="https://yoriiis.github.io/vlitejs/demo" title="Demo" class="custom-button"> <img alt="Screenshot" src="images/demo.jpg" /> </a> </p></p> <h2 id="philosophy">Philosophy<a class="headerlink" href="#philosophy" title="Permanent link">&para;</a></h2> <p>vLitejs was created with the minimum functionality required for a video player with a custom theme. The performance and weight of the library are therefore very important and this is the main vision of vLitejs.</p> <p>The library is composed of a Javascript <code>Player</code> class, extended by Youtube and HTML5 videos. It is therefore possible to add other popular video services in the future.</p> <h2 id="github-npm">Github &amp; npm<a class="headerlink" href="#github-npm" title="Permanent link">&para;</a></h2> <p>The plugin is available as the <code>vlitejs</code> package name on <a href="https://github.com/yoriiis/vlitejs">Github</a> and <a href="https://www.npmjs.com/package/vlitejs">npm</a>.<br /> If you like the project, like it on Github 😃<br /><br /> <a class="github-button" href="https://github.com/yoriiis/vlitejs" data-icon="octicon-star" data-size="large" data-show-count="true" aria-label="Star yoriiis/vlitejs on GitHub">Star</a></p> <h2 id="browsers-support">Browsers support<a class="headerlink" href="#browsers-support" title="Permanent link">&para;</a></h2> <p>The project is fully compatible with the most popular web browsers. More information about the HTML5 video support on <a href="https://caniuse.com/#feat=video" target="_blank" title="Video element - Can I use">Can I Use</a>. HTML and CSS files are W3C valid.</p> <h2 id="licence">Licence<a class="headerlink" href="#licence" title="Permanent link">&para;</a></h2> <p>vLitejs and his documentation are licensed under the <a href="http://opensource.org/licenses/MIT">MIT License</a>.<br /> Created with ♥ by <a href="http://github.com/yoriiis">@yoriiis</a>.</p> <h2 id="contributors">Contributors<a class="headerlink" href="#contributors" title="Permanent link">&para;</a></h2> <div class="admonition note"> <p class="admonition-title">Contributors</p> <p>Many thanks to Maxime LEROUGE for its contribution and <a href="https://www.behance.net/victorshm" target="_blank" title="Victor Schirm">Victor Schirm</a> for the vLitejs logo 👍</p> </div> <script async defer src="https://buttons.github.io/buttons.js"></script> <script> ((window.gitter = {}).chat = {}).options = { room: 'vlitejs/vlitejs' }; </script> <script src="https://sidecar.gitter.im/dist/sidecar.v1.js" async defer></script> </article> </div> </div> </main> <footer class="md-footer"> <div class="md-footer-nav"> <nav class="md-footer-nav__inner md-grid"> <a href="getting-started.html" title="Getting started" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next"> <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> <span class="md-flex__ellipsis"> <span class="md-footer-nav__direction"> Next </span> Getting started </span> </div> <div class="md-flex__cell md-flex__cell--shrink"> <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i> </div> </a> </nav> </div> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class="md-footer-copyright"> <div class="md-footer-copyright__highlight"> Copyright &copy; 2019 - Joris DANIEL aka Yoriiis </div> powered by <a href="https://www.mkdocs.org">MkDocs</a> and <a href="https://squidfunk.github.io/mkdocs-material/"> Material for MkDocs</a> </div> <div class="md-footer-social"> <link rel="stylesheet" href="assets/fonts/font-awesome.css"> <a href="https://github.com/yoriiis" class="md-footer-social__link fa fa-github"></a> <a href="https://www.linkedin.com/in/jorisdaniel" class="md-footer-social__link fa fa-linkedin"></a> </div> </div> </div> </footer> </div> <script src="assets/javascripts/application.ac79c3b0.js"></script> <script>app.initialize({version:"1.0.4",url:{base:"."}})</script> </body> </html>