Skip to main content

đź”®refr

npm npm npm

  • Performance: It's the fastest way to animate in React. It doesn't have to go through the React reconciler.
  • Familiar: It's a hook, so you can use it in any function component.
  • Simple: It's just a single function that you can call from anywhere.
  • Predictable: You can cancel your animation at any time and it will run at 60fps.
  • Composable: You can use it in conjunction with the state hook to create animations.
  • Extensible: You can write your own hooks that depend on it.
  • Flexible: You can use it to schedule updates or to set timeouts.

It's just a single function that you can call from anywhere. It's a hook that will run on every frame and give you the time delta. If you return true it will keep running, otherwise it will cancel.

You can also use it to set timeouts that will run on the next frame. This is useful when you want to force an update after a state change.

Installation​

npm install refr

Documentation​

Docs : refr Introduction​
API : refr API and feature​
Guide : refr Getting Started​

Ecosystem​

🌇 glre: GLSL Reactive Engine​
⛪️ reev: reactive event state manager​

Staying informed​

github discussions welcome✨​
@tseijp twitter​
tsei.jp articles​

PRs​

welcome✨​

API​

import frame from 'refr'

// Schedule an update
frame.mount((dt) => {})

// Start an update loop
frame.mount((dt) => true)

// Cancel an update
frame.cancel(fn)

// Start the update loop
frame.start()

// Pause the update loop
frame.pause()

// Stop the update loop
frame.stop()

// Restart the update loop
frame.restart()

// Set a timeout that runs on nearest frame
frame.setTimeout(() => {}, 1000)

// Get the current time
frame.now() // => number

Getting Started​

import { useFrame } from 'refr'

function TrailSphere() {
        // Schedule an update
        useFrame((ts) => {})

        // Start an update loop
        useFrame((ts) => true)
}

License​

MIT