Skip to content

dejorrit/sprite-gif

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

52 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sprite Gif

Demo

👉 Check out the demo

Usage

Use a service like ezgif.com to create a sprite from your gif. Make sure you select "Stack horizontally".

Install the package

yarn add sprite-gif

Your HTML

<div id="myGif" width="320" height="280"></div>

Your Javascript

import SpriteGif from 'sprite-gif';
 
let gif = new SpriteGif(document.getElementById('myGif'), {
  sprite: './sprite.png',
});
 
gif.play();
gif.pause();
gif.stop();
gif.setLoop(true);
gif.setSpeed(1);
gif.setFrameRate(30);

Options

You can add some optional settings to the settings object:

autostart (Boolean)

default: true

loop (Boolean)

default: true

speed (Number)

default: 1

frameRate (Number)

default: 30

Methods

play()

pause()

stop()

setLoop(false)

setSpeed(2)

setFrameRate(40)

About

Play, pause, loop and control the speed of gifs using sprites

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published