quicktube

3.1.2 • Public • Published

Quicktube npm Build Status Coverage Status

A lightweight embed video player, with support for YouTube and Vimeo. Check out our online demo!

Usage

npm install --save quicktube

Initial setup

Is really simple. Just add the video ID to data-quicktube='{video-id}' and data-quicktube-play='{video-id}' to the play trigger element.

<div class="quicktube" data-quicktube="k6QanQUaDOo">
    <div class="quicktube__video" data-quicktube-video></div>
    <div data-quicktube-play="k6QanQUaDOo" class="quicktube__poster" data-quicktube-poster>
        <!-- Optional poster frame image -->
        <img class="quicktube__poster-image" src="/path/to/image" />
        <button class="quicktube__play quicktube__btn">
            Play
        </button>
    </div>
</div>

Initialise quicktube.

import quicktube from 'quicktube';

document.addEventListener('DOMContentLoaded', () => {
    quicktube.init();
}, false);

⚠️ Don't forget to include the necessary CSS, as well as the required polyfills should your environment require it.

API

You can hook to the play and pause events like this:

window.addEventListener('quicktube:play', () => {
    showingItem.style.display = 'block';
}, false);

window.addEventListener('quicktube:pause', () => {
    showingItem.style.display = 'none';
}, false);

Advanced

Usage with CSP (Content Security Policy) headers

Quicktube's code relies on the YouTube and Vimeo APIs (depending on which provider is used), for which origins need to be whitelisted in order to work with CSP.

For YouTube, whitelist the following:

# As script-src:
https://www.youtube.com
https://s.ytimg.com

# As frame-src:
https://www.youtube.com

And for Vimeo:

# As script-src:
https://player.vimeo.com

# As `frame-src:
https://player.vimeo.com

Note that the following are based on origins of the API scripts, and (undocumented) origins loaded by those scripts, as observed on our online demo.

Development

Install

Clone the project on your computer, and install Node. This project also uses nvm.

nvm install
# Then, install all project dependencies.
npm install

Releases

  • Make a new branch for the release of the new version.
  • Update the CHANGELOG.
  • Update the version number in package.json, following semver.
  • Make a PR and squash merge it.
  • Back on master with the PR merged, follow the instructions below.
npm run dist
# Use irish-pub to check the package content. Install w/ npm install -g first.
irish-pub
npm publish
  • Finally, go to GitHub and create a release and a tag for the new version.
  • Done!

Documentation

Package Sidebar

Install

npm i quicktube

Weekly Downloads

68

Version

3.1.2

License

MIT

Unpacked Size

43.5 kB

Total Files

7

Last publish

Collaborators

  • springloaders
  • thibaudcolas
  • holloway
  • synecdokey
  • yuzima