https://github.com/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.
https://github.com/johnsonjo4531/videojs-gifplayer
gif javascript video-player videojs videojs-plugin
Last synced: 11 months ago
JSON representation
Plays gifs that are in video format automatically with looping only when in viewport in similar fashion to twitter's gif player.
- Host: GitHub
- URL: https://github.com/johnsonjo4531/videojs-gifplayer
- Owner: johnsonjo4531
- License: mit
- Created: 2017-02-11T03:25:39.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-03-30T23:43:16.000Z (about 9 years ago)
- Last Synced: 2025-07-26T14:09:44.558Z (11 months ago)
- Topics: gif, javascript, video-player, videojs, videojs-plugin
- Language: JavaScript
- Size: 24.4 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# 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
```sh
npm install --save videojs-gifplayer
```
The npm installation is preferred, but Bower works, too.
```sh
bower install --save videojs-gifplayer
```
## Usage
To include videojs-gifplayer on your website or web application, use any of the following methods.
### `` Tag
This is the simplest case. Get the script in whatever way you prefer and include the plugin _after_ you include [video.js][videojs], so that the `videojs` global is available.
```html
<script src="//path/to/video.min.js">
var player = videojs('my-video');
player.gifplayer();
```
### Browserify
When using with Browserify, install videojs-gifplayer via npm and `require` the plugin as you would any other module.
```js
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:
```js
require(['video.js', 'videojs-gifplayer'], function(videojs) {
var player = videojs('my-video');
player.gifplayer();
});
```
### Options
default options are:
```js
{
// options for videojs plugin
controls: false,
loop: true,
// options specific to videojs-gifplayer plugin
restartOnPause: true
}
```
## License
MIT. Copyright (c) John D. Johnson II <johnsonjo4531@gmail.com>
[videojs]: http://videojs.com/