3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-07-27 05:28:43 +02:00
Code Issues Projects Releases Packages Wiki Activity

chore: Enable ESLint rules of hooks + fix new lint errors (#5714)

Browse source
This commit is contained in:
Sébastien Lorber 2021-10-20 16:09:52 +02:00 • committed by GitHub
parent 3db4fcaec7
commit 098f210890
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
16 changed files with 110 additions and 48 deletions
Download patch file Download diff file Expand all files Collapse all files

38
packages/docusaurus-theme-common/src/utils/scrollUtils.tsx
View file

@ -15,6 +15,7 @@ import React, {
useMemo,
useRef,
} from 'react';
import {useDynamicCallback} from './reactUtils';
import ExecutionEnvironment from '@docusaurus/ExecutionEnvironment';
/**
@ -103,20 +104,22 @@ export function useScrollPosition(
const {scrollEventsEnabledRef} = useScrollController();
const lastPositionRef = useRef<ScrollPosition | null>(getScrollPosition());
const handleScroll = () => {
if (!scrollEventsEnabledRef.current) {
return;
}
const currentPosition = getScrollPosition()!;
if (effect) {
effect(currentPosition, lastPositionRef.current);
}
lastPositionRef.current = currentPosition;
};
const dynamicEffect = useDynamicCallback(effect);
useEffect(() => {
const handleScroll = () => {
if (!scrollEventsEnabledRef.current) {
return;
}
const currentPosition = getScrollPosition()!;
if (dynamicEffect) {
dynamicEffect(currentPosition, lastPositionRef.current);
}
lastPositionRef.current = currentPosition;
};
const opts: AddEventListenerOptions & EventListenerOptions = {
passive: true,
};
@ -125,7 +128,12 @@ export function useScrollPosition(
window.addEventListener('scroll', handleScroll, opts);
return () => window.removeEventListener('scroll', handleScroll, opts);
}, deps);
}, [
dynamicEffect,
scrollEventsEnabledRef,
// eslint-disable-next-line react-hooks/exhaustive-deps
...deps,
]);
}
type UseScrollPositionSaver = {
@ -170,7 +178,7 @@ function useScrollPositionSaver(): UseScrollPositionSaver {
return {restored: heightDiff !== 0};
}, []);
return useMemo(() => ({save, restore}), []);
return useMemo(() => ({save, restore}), [restore, save]);
}
type UseScrollPositionBlockerReturn = {
@ -217,7 +225,7 @@ export function useScrollPositionBlocker(): UseScrollPositionBlockerReturn {
}
};
},
[scrollController],
[scrollController, scrollPositionSaver],
);
useLayoutEffect(() => {