GithubHelp home page GithubHelp logo

johnsonjo4531 / videojs-gifplayer Goto Github PK

View Code? Open in Web Editor NEW
0.0 2.0 1.0 25 KB

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

License: MIT License

HTML 15.53% JavaScript 82.14% CSS 2.33%
videojs gif video-player javascript videojs-plugin

videojs-gifplayer's Introduction

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 People

Watchers

 avatar  avatar

Forkers

davidpmccormick

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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.