johnsonjo4531 / videojs-gifplayer

Plays gifs that are in video format automatically with looping only when in viewport in similar fashion to twitter's gif player.

videojs-gifplayer

Plays gifs that are in video format automatically with looping only when in viewport in similar fashion to twitter's gif player.

Table of Contents

Installation

npm install --save videojs-gifplayer

The npm installation is preferred, but Bower works, too.

bower install  --save videojs-gifplayer

Usage

To include videojs-gifplayer on your website or web application, use any of the following methods.

<script> Tag

This is the simplest case. Get the script in whatever way you prefer and include the plugin after you include video.js, so that the videojs global is available.

<script src="//path/to/video.min.js"></script>
<script src="//path/to/videojs-gifplayer.min.js"></script>
<script>
  var player = videojs('my-video');

  player.gifplayer();
</script>

Browserify

When using with Browserify, install videojs-gifplayer via npm and require the plugin as you would any other module.

var videojs = require('video.js');

// The actual plugin function is exported by this module, but it is also
// attached to the `Player.prototype`; so, there is no need to assign it
// to a variable.
require('videojs-gifplayer');

var player = videojs('my-video');

player.gifplayer();

RequireJS/AMD

When using with RequireJS (or another AMD library), get the script in whatever way you prefer and require the plugin as you normally would:

require(['video.js', 'videojs-gifplayer'], function(videojs) {
  var player = videojs('my-video');

  player.gifplayer();
});

Options

default options are:

{
  // options for videojs plugin
  controls: false,
  loop: true,
  // options specific to videojs-gifplayer plugin
  restartOnPause: true
}

License

MIT. Copyright (c) John D. Johnson II <[email protected]>

videojs-gifplayer's Issues

Use throttle instead of debounce

On scroll listening throttle should be used instead of debounce. This will allow the video to play and pause while the user is scrolling continuously.

nodeList forEach() not widely supported

I get an error on Chrome and a crash on IE on this line:
451: gifPlayers.forEach(function gifPlayerHandler(gifPlayer) {

see here: http://stackoverflow.com/a/10493129

a fast fix was to prepend
gifPlayers = Array.prototype.slice.call(gifPlayers);