Skip to content

Latest commit

History

History
79 lines (58 loc) 路 1.34 KB

README.md

File metadata and controls

79 lines (58 loc) 路 1.34 KB

Installation

$ npm i raf-pause

or

$ yard add raf-pause

API

start()

Start the timer.

clean()

Clean the timer.

Recipes

import rafPause from 'raf-pause'

const run = rafPause(() => {
  // do something
}, 500)
run.start()


const runAndLoop = rafPause(() => {
  // do something in loop
  runAndLoop.start()
}, 500)

runAndLoop.start()

In React

import rafPause from 'raf-pause'

componentDidMount() {
  this.countDown.start()
}

componentWillUnMount() {
  this.countDown.clean()
}

countDown = rafPause(() => {
  this.setState({
    ...
  }, this.countDown)
}, 1000)

Fallback

It'll fallback to setTimeout if browsers don't support requestAnimationFrame