npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

sibgif

v1.0.1

Published

A library for manipulating GIFs in the browser.

Downloads

527

Readme

Overview

Re-forked from BuzzFeed's libgif project (https://github.com/buzzfeed/libgif-js), which was forked from the excelent[sic] jsgif project (https://github.com/shachaf/jsgif), which was implemented as a bookmarklet to manipulate animated gifs (http://slbkbs.org/jsgif).

This is an attempt to modernize the async handling of the library (which was not very good), and also to add some features which I found useful, such as exposing the frames object with an optional data URL for each frame.

Example

See example.html for some super basic examples, if you're not familiar with the library.

See async_example.html for tips on using this library with async.

See tween_example.html for a cool application of the library: gifs that play/rewind as you scroll the page.

Please note: examples must be loaded via a webserver, not directly from disk. I.e. http://localhost/sibgif/example.html NOT file:///sibgif/example.html. See the same-domain origin caveat at the bottom of this document for more information. I use http-server to do this, and you should too!

There are also hosted demos of basic usage, async compatibility, and scroll-based gif animations.

Class: SuperGif

Example Usage:

<img id="myImage" src="./example1_preview.gif" data-animated-source="./example1.gif"
	width="360" height="360" data-autoplay="1" />

<!-- load the library -->
<script type="text/javascript" src="js/sibgif.min.js"></script>

<script type="text/javascript">
	var gif = new SuperGif({
		gif: document.getElementById('myImage')
	});
	gif.load(function (err) {
		if (err) {
			console.error(err);
		} else {
			console.log('Yay, the gif loaded!');
		}
	});
</script>

Image tag attributes:

  • data-animated-source - If this url is specified, it's loaded into the player instead of src. This allows a preview frame to be shown until animated gif data is streamed into the canvas

  • data-autoplay - Defaults to 1 if not specified. If set to zero, a call to the play() method is needed

Constructor options

  • gif - Required. The DOM element of an img tag.
  • loop_mode - Optional. Setting this to false will force disable looping of the gif.
  • auto_play - Optional. Same as the rel:auto_play attribute above, this arg overrides the img tag info.
  • max_width - Optional. Scale images over max_width down to max_width. Helpful with mobile.
  • on_end - Optional. Add a callback for when the gif reaches the end of a single loop (one iteration). The first argument passed will be the gif HTMLElement.
  • loop_delay - Optional. The amount of time to pause (in ms) after each single loop (iteration).
  • show_progress_bar - Optional. Setting this to false will disable the loading progress bar.
  • progressbar_height - Optional. The height (in px) of the progress bar. Default: 25.
  • progressbar_background_color - Optional. The background color of the progress bar. Default: 'rgba(255,255,255,0.4)'.
  • progressbar_foreground_color - Optional. The foreground color of the progress bar. Default: rgba(255,0,22,.8)'.
  • includeDataURL - Optional. Setting this to true will include the dataURL property in each frame object.

Instance methods

loading

  • load(callback) - Loads the gif specified by the src or rel:animated_src sttributie of the img tag into a canvas element and then calls callback if one is passed
  • load_url(src, callback) - Loads the gif file specified in the src argument into a canvas element and then calls callback if one is passed

play controls

  • play - Start playing the gif
  • pause - Stop playing the gif
  • move_to(i) - Move to frame i of the gif
  • move_relative(i) - Move i frames ahead (or behind if i < 0)

getters

  • get_canvas - The canvas element that the gif is playing in. Handy for assigning event handlers to.
  • get_frames - The list of frames objects, containing an ImageData instance, a dataURL string, and a delay amount.
    • frame object
      • data - an ImageData instance for the frame
      • dataURL - a dataURL for this image. Can be loaded into an HTLM <img> DOM element. Only present if the includeDataURL constructor option is set.
      • delay - the delay for this frame
  • get_playing - Whether or not the gif is currently playing
  • get_loading - Whether or not the gif has finished loading/parsing
  • get_auto_play - Whether or not the gif is set to play automatically
  • get_length - The number of frames in the gif
  • get_current_frame - The index of the currently displayed frame of the gif

Caveat: same-domain origin

The gif has to be on the same domain (and port and protocol) as the page you're loading.

The library works by parsing gif image data in js, extracting individual frames, and rendering them on a canvas element. There is no way to get the raw image data from a normal image load, so this library does an XHR request for the image and forces the MIME-type to "text/plain". Consequently, using this library is subject to all the same cross-domain restrictions as any other XHR request.