react-use/src/useRafLoop.ts
xobotyi baa2f7511e
feat(useRafLoop): reworked the hook, now it do not re-render parent component.
BREAKING CHANGE: changed return array, now it returns only functions in next order: [stop, start, isActive].

Parent component is not re-rendered on loop start/stop.
2020-04-01 10:43:31 +03:00

46 lines
1.2 KiB
TypeScript

import { useCallback, useEffect, useMemo, useRef } from 'react';
export type RafLoopReturns = [() => void, () => void, () => boolean];
export default function useRafLoop(callback: FrameRequestCallback, initiallyActive = true): RafLoopReturns {
const raf = useRef<number | null>(null);
const rafActivity = useRef<boolean>(false);
const rafCallback = useRef(callback);
rafCallback.current = callback;
const step = useCallback((time: number) => {
if (rafActivity.current) {
rafCallback.current(time);
raf.current = requestAnimationFrame(step);
}
}, []);
const result = useMemo(() => ([
() => { // stop
if (rafActivity.current) {
rafActivity.current = false;
raf.current && cancelAnimationFrame(raf.current);
}
},
() => { // start
if (!rafActivity.current) {
rafActivity.current = true;
raf.current = requestAnimationFrame(step);
}
},
(): boolean => rafActivity.current // isActive
// eslint-disable-next-line react-hooks/exhaustive-deps
] as RafLoopReturns), []);
useEffect(() => {
if (initiallyActive) {
result[1]();
}
return result[0];
// eslint-disable-next-line react-hooks/exhaustive-deps
}, []);
return result;
}