react-frame-animator
v1.0.1
Published
A simple frame animator component for React.
Downloads
7
Maintainers
Readme
React Frame Animator
A simple react component that animates an array of frames.
Getting Started
Install
Using yarn:
yarn add react-frame-animator
Using npm:
npm i -S react-frame-animator
Usage
- Import After Installation
import FrameAnimator from 'react-frame-animator';
- Add the Component to Your App
<FrameAnimator frames={frames} speed={500} />
Props
| Name | Description | Type | Values | |----| ---------| ---| ------| | frames * | List of frames to be animated. This can be a url, file path, or image data. | String Array | [ "img/walk_up1.png", "img/walk_up2.png" ] | | speed * | The speed in milliseconds of the animation. | Number | 500, 30, 1000 | | playMode | The mode in which the animation will play. | Number | playModes.NORMAL (Default), playModes.LOOP, playModes.REVERSE, playModes.LOOP_REVERSE |
Note: playModes
can be imported as follows:
import { playModes } from 'react-frame-animator';
Development
Install Dependencies:
yarn install
Run the Demo:
yarn run demo
Build:
yarn run build
License
This project is licensed under the MIT License - see the LICENSE for details.