request-animation-runner

!npm bundle size

Class for run loop animation with RAF

Install

npm

``sh
npm install request-animation-runner
`

yarn

`sh
yarn add request-animation-runner
`

Usage

`js
import RequestAnimation from 'request-animation-runner';

const requestAnimation = new RequestAnimation();

requestAnimation.activate();
requestAnimation.run(() => {
// some logic
});
`

API

$3

Disable call requests.

`js
requestAnimation.deactivate();
requestAnimation.run(() => {
// some logic
}); // no effect

requestAnimation.activate();
requestAnimation.run(() => {
// some logic
}); // handler is called
`

$3

Enable call requests.

`js
requestAnimation.deactivate();
requestAnimation.run(() => {
// some logic
}); // no effect

requestAnimation.activate();
requestAnimation.run(() => {
// some logic
}); // handler is called
`

$3

Resolve the animation loop calculates time elapsed since the last loop and only draws if your specified fps interval is achieved.

- @param {function} animationFunc - Function for animation
- @param {string} fps - Frames per Second

- @returns {undefined}

`js
requestAnimation.run(() => {
// some logic
});
`

$3

Request single call.

- @param {function} animationFunc - Function for animation

- @returns {undefined}

`js
requestAnimation.request(() => {
// some logic
});
`

$3

Cancel current request.

- @returns {undefined}

`js
requestAnimation.cancelRequest();
`

Run tests

`sh
npm test
``

Maintainer

Krivega Dmitriy

- Website: https://krivega.com
- Github: @Krivega

Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page. You can also take a look at the contributing guide.

📝 License

Copyright © 2020 Krivega Dmitriy.

This project is MIT licensed.