npm

Share private packages across your team with npm Orgs, now with simplified billing via the aws marketplace!Learn more »

freezeframe

4.0.0 • Public • Published

Freezeframe.js

npm version Coverage Status Size License: MIT

Freezeframe.js is a library that pauses animated .gifs and enables them to animate on mouse hover / mouse click / touch event, or manually via class methods.

Version 4.x no longer requires or supports jQuery. If you want to use freezeframe as a jQuery plugin, check out freezeframe v3.0.10.

Examples

http://ctrl-freaks.github.io/freezeframe.js/

Installation

If your project supports ES6 modules or commonjs modules, install via npm or yarn:

npm

npm install freezeframe

yarn

yarn add freezeframe

CDN

If not, you can pull in the library from a CDN:

<script src="https://unpkg.com/freezeframe/dist/freezeframe.min.js"></script>

Setup

Add freezeframe as a class name on the .gifs you want processed.
( You can optionally use a custom selector as shown in Advanced Usage. )

<img class="freezeframe" src="image.gif" />

It is also possible to put the .freezeframe class on a parent element containing as many gifs as you want:

<div class="freezeframe">
  <img src="image1.gif">
  <img src="image2.gif">
  <img src="image3.gif">
</div>

Usage

If your environment supports commonjs modules (require) or es6 module imports (import), you can import freezeframe like so:

// es6 modules
import Freezeframe from 'freezeframe';
 
// or commonjs
const Freezeframe = require('freezeframe');

However, if you are using the CDN version, you can just access the global variable, Freezeframe.

✨ Now time to Freeze those frames ✨

new Freezeframe();

Advanced Usage

freezeframe.js exposes public methods to allow for more custom integration. You have the option of manually controlling when freezeframe triggers images, adds support elements, and attaches event handlers. You can also manually trigger and release animation on one image or a group of images. These methods are described in detail in the Methods section.

Example: trigger logo .gif and manually trigger / release animation:

// setup freezeframe instance with custom selector and options
 
const logo = new Freezeframe('#logo', {
  trigger: false
});
 
logo.start(); // start animation
logo.stop(); // stop animation

Options

  • ### selector

    type: string | DOM object
    default: ".freezeframe"

    The selector used to search for .gifs to freeze. Selector may either be passed as the first argument of the Freezeframe constructor, or as a property of the options object. You may pass a string selector or a DOM reference. If a string is passed, we use querySelectorAll.

  • ### trigger

    type: string | boolean
    default: "hover"
    options: "hover", "click", false

    The trigger event to start animation for non-touch devices.

  • ### overlay

    type: boolean
    default: false

    Whether or not to display a play icon on top of the paused image.

  • ### responsive

    type: boolean
    default: true

    Whether or not to make the image responsive (100% width)

Methods

  • ### Freezeframe(options)

    Create a new freezeframe object instance.
    Can be passed options. Strings will be interpreted as the selector option.

    // Default options
    new Freezeframe();
     
    // String as selector
    new Freezeframe('.foo');
     
    // DOM reference as selector
    new Freezeframe(document.querySelectorAll('.foo'));
     
    // Custom options
    new Freezeframe({
      selector: '.foo',
      trigger: 'click',
      overlay: true,
      responsive: false
    });
     
    // Also valid syntax
    new Freezeframe('.foo', {
      trigger: 'click',
      overlay: true,
      responsive: false
    });
  • ### start()

    Start animation, or restarts animation from the first frame if the .gif is already animating.

    // first, save a reference to your freezeframe instance
     
    const ff = new Freezeframe({
      trigger: false
    });
     
    ff.start();
  • ### stop()

    Stops animation.

    ff.stop();
  • ### on(event, callback)

    Add event listeners to a freezeframe instance.

    • event

      type: string
      options: start|stop|toggle

    • callback

      type: function
      params:

      • items: array<freezeframe> | freezeframe
      • isPlaying: boolean

    For example:

    ff.on('start', (items) => {
      // do something on start
    };
     
    ff.on('stop', (items) => {
      // do something on stop
    };
     
    ff.on('toggle', (items, isPlaying) => {
      if (isPlaying) {
        // do something on start
      } else {
        // do something on stop
      }
    };

Contributing

Assuming you have already read the instructions in the project root:

  • First, cd into the appropriate package directory
# start webpack dev server 
npm start
# build the project and examples for gh-pages 
npm run build
# run unit tests 
npm test

Then commit your changes and submit your PR for review.

License

freezeframe.js is released under the terms of the MIT License.

Thanks

install

npm i freezeframe

Downloadsweekly downloads

213

version

4.0.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability