R
fn

useRafFn

testeddemo

Call a function on every `requestAnimationFrame` with delta time tracking. Automatically cleans up when the component scope is disposed.

Example

ts
const { pause, resume, isActive } = useRafFn(({ delta, timestamp }) => {
  console.log(`${delta}ms since last frame`);
});

Demo

Loading demo…

Signature

ts
export function useRafFn(
  callback: (args: UseRafFnCallbackArgs) => void,
  options: UseRafFnOptions ={ ... }

Parameters

ParameterTypeDescription
callback(args: UseRafFnCallbackArgs) => voidFunction to call on every animation frame
options?UseRafFnOptionsConfiguration options

Returns

UseRafFnReturn