Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/julienetie/request-frame
The most complete requestAnimationFrame | cancelAnimationFrame polyfill
https://github.com/julienetie/request-frame
Last synced: 16 days ago
JSON representation
The most complete requestAnimationFrame | cancelAnimationFrame polyfill
- Host: GitHub
- URL: https://github.com/julienetie/request-frame
- Owner: julienetie
- License: mit
- Created: 2015-07-25T19:44:10.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2019-11-18T12:29:47.000Z (about 5 years ago)
- Last Synced: 2024-12-11T17:05:27.086Z (21 days ago)
- Language: JavaScript
- Homepage:
- Size: 86.9 KB
- Stars: 67
- Watchers: 6
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
`* *` _If you are not supporting browsers from IE9 and below, you probably don't need this or any equivalent polyfill_ `* *`
# request-frame
### A comprehensive requestAnimationFrame & cancelAnimationFrame polyfill.
- Supports ES6 - AMD - CJS & IIFE
- Provides a clean polyfill for requestAnimationFrame & cancelAnimationFrame.
- Tested & working on: IE 5.5+, FF 3+, Opera 11.16+, Safari 4+, Chrome 14+, iOS 3+, Android 2.3+, Android Chrome 28+.
- **iOS 6 bug fix** without user-agent sniffing.
- **Firefox 4 - 10 function mismatch normalization**.
- Doesn't modify native functions unless specified.
- AMD compliant.
#### Install options
`npm i request-frame --save` ** | ** `bower i request-frame` ** | ** [src](https://github.com/julienetie/request-frame/tree/master/dist) ** | ** [release](https://github.com/julienetie/request-frame/releases)
```javascript
import requestFrame from 'request-frame'; // ES6
```
```javascript
// AMD, IIFE
```
```javascript
const requestFrame = require('request-frame'); // CJS
```
### The API:
#### Assign the timing functions:
*requestFrame( request | cancel | native )* request is default.
```javascript
var request = requestFrame('request'); // window.requestAnimationFrame | setTimeout
var cancel = requestFrame('cancel'); // window.cancelAnimationFrame | cancelTimeout
```
#### Or re/ assign native functions:
```javascript
requestFrame('native'); // re/ declares requestAnimationFrame & cancelAnimationFrame
```
Below is just an example of the requestAnimationFrame API, see links: [MDN](https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame), [MSDN](https://msdn.microsoft.com/en-us/library/windows/apps/hh453388.aspx) & [W3](http://www.w3.org/TR/2011/WD-html5-20110525/timers.html).
#### Loop something:
```javascript
var requestId;
function something( useTimeStamp ){
// Do something here
requestId = request(something);
}
requestId = request(something); // Assigns Id & calls "something"
```
#### Cancel something:
```javascript
cancel(requestId); // Cancels frame request
```
### The ideology
request-frame aims to provide an optimal development consistency with the use of animation timing functions across the large number of browsers and devices. This lib is ideal for those who may want to avoid re-assigning native functions, or avoid interfering with other libs that do. requestFrame() is purposely not a constructor. The intention is for requestAnimationFrame to be used once or few times during execution since multiple task are expected to be more efficient via a single requestAnimationFrame loop compared to several instances.
### Browsers tested & passing:
Supports everything from IE5+
### Contribute
Just do it!
#### Test
`npm run test`
To launch port 9999
- ./test/
- ./test/compatibility-assignation-amd.html
- ./test/compatibility-assignation.html
- ./test/compatibility-native-amd.html
- ./test/compatibility-native.html
_Browser based testing for RAF is imperative_
---
[MIT License](https://github.com/julienetie/request-frame/blob/master/LICENSE)
© 2016 Julien Etienne