@docusaurus/theme-classic 2.0.0-beta.8bda3b2db → 2.0.0-beta.9

package/src/theme/hooks/useHideableNavbar.ts

@@ -5,76 +5,63 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import {useState, useCallback, useEffect, useRef} from 'react';
-import {useLocation} from '@docusaurus/router';
-import useScrollPosition from '@theme/hooks/useScrollPosition';
-import {useLocationChange} from '@docusaurus/theme-common';
+import {useState, useCallback, useRef} from 'react';
+import {useLocationChange, useScrollPosition} from '@docusaurus/theme-common';
 import type {useHideableNavbarReturns} from '@theme/hooks/useHideableNavbar';
 
 const useHideableNavbar = (hideOnScroll: boolean): useHideableNavbarReturns => {
-  const location = useLocation();
   const [isNavbarVisible, setIsNavbarVisible] = useState(hideOnScroll);
   const isFocusedAnchor = useRef(false);
-  const [navbarHeight, setNavbarHeight] = useState(0);
+  const navbarHeight = useRef(0);
   const navbarRef = useCallback((node: HTMLElement | null) => {
     if (node !== null) {
-      setNavbarHeight(node.getBoundingClientRect().height);
+      navbarHeight.current = node.getBoundingClientRect().height;
     }
   }, []);
 
-  useScrollPosition(
-    ({scrollY: scrollTop}, {scrollY: lastScrollTop}) => {
-      if (!hideOnScroll) {
-        return;
-      }
-
-      if (scrollTop < navbarHeight) {
-        setIsNavbarVisible(true);
-        return;
-      }
-
-      if (isFocusedAnchor.current) {
-        isFocusedAnchor.current = false;
-        setIsNavbarVisible(false);
-        return;
-      }
-
-      if (lastScrollTop && scrollTop === 0) {
-        setIsNavbarVisible(true);
-      }
+  useScrollPosition((currentPosition, lastPosition) => {
+    if (!hideOnScroll) {
+      return;
+    }
 
-      const documentHeight =
-        document.documentElement.scrollHeight - navbarHeight;
-      const windowHeight = window.innerHeight;
+    const scrollTop = currentPosition.scrollY;
 
-      if (lastScrollTop && scrollTop >= lastScrollTop) {
-        setIsNavbarVisible(false);
-      } else if (scrollTop + windowHeight < documentHeight) {
-        setIsNavbarVisible(true);
-      }
-    },
-    [navbarHeight, isFocusedAnchor],
-  );
+    // It needed for mostly to handle rubber band scrolling
+    if (scrollTop < navbarHeight.current) {
+      setIsNavbarVisible(true);
+      return;
+    }
 
-  useLocationChange((locationChangeEvent) => {
-    if (!hideOnScroll || locationChangeEvent.location.hash) {
+    if (isFocusedAnchor.current) {
+      isFocusedAnchor.current = false;
       return;
     }
 
-    setIsNavbarVisible(true);
+    const lastScrollTop = lastPosition?.scrollY;
+    const documentHeight =
+      document.documentElement.scrollHeight - navbarHeight.current;
+    const windowHeight = window.innerHeight;
+
+    if (lastScrollTop && scrollTop >= lastScrollTop) {
+      setIsNavbarVisible(false);
+    } else if (scrollTop + windowHeight < documentHeight) {
+      setIsNavbarVisible(true);
+    }
   });
 
-  useEffect(() => {
+  useLocationChange((locationChangeEvent) => {
     if (!hideOnScroll) {
       return;
     }
 
-    if (!location.hash) {
+    if (locationChangeEvent.location.hash) {
+      isFocusedAnchor.current = true;
+      setIsNavbarVisible(false);
       return;
     }
 
-    isFocusedAnchor.current = true;
-  }, [location.hash]);
+    setIsNavbarVisible(true);
+  });
 
   return {
     navbarRef,

package/src/theme/hooks/useTabGroupChoice.ts

@@ -21,13 +21,13 @@ const useTabGroupChoice = (): useTabGroupChoiceReturns => {
 
   useEffect(() => {
     try {
-      const localStorageChoices = {};
-      for (const storageKey of listStorageKeys()) {
+      const localStorageChoices: Record<string, string> = {};
+      listStorageKeys().forEach((storageKey) => {
         if (storageKey.startsWith(TAB_CHOICE_PREFIX)) {
           const groupId = storageKey.substring(TAB_CHOICE_PREFIX.length);
-          localStorageChoices[groupId] = createStorageSlot(storageKey).get();
+          localStorageChoices[groupId] = createStorageSlot(storageKey).get()!;
         }
-      }
+      });
       setChoices(localStorageChoices);
     } catch (err) {
       console.error(err);

package/src/theme/hooks/useTheme.ts

@@ -68,7 +68,7 @@ const useTheme = (): useThemeReturns => {
     } catch (err) {
       console.error(err);
     }
-  }, [setTheme]);
+  }, [disableSwitch, setTheme]);
 
   useEffect(() => {
     if (disableSwitch && !respectPrefersColorScheme) {
@@ -80,7 +80,7 @@ const useTheme = (): useThemeReturns => {
       .addListener(({matches}) => {
         setTheme(matches ? themes.dark : themes.light);
       });
-  }, []);
+  }, [disableSwitch, respectPrefersColorScheme]);
 
   return {
     isDarkTheme: theme === themes.dark,

package/src/theme/hooks/useWindowSize.ts

@@ -10,42 +10,60 @@ import {useEffect, useState} from 'react';
 import ExecutionEnvironment from '@docusaurus/ExecutionEnvironment';
 import type {WindowSize} from '@theme/hooks/useWindowSize';
 
-const desktopThresholdWidth = 996;
-
 const windowSizes = {
   desktop: 'desktop',
   mobile: 'mobile',
+
+  // This "ssr" value is very important to handle hydration FOUC / layout shifts
+  // You have to handle server-rendering explicitly on the call-site
+  // On the server, you may need to render BOTH the mobile/desktop elements (and hide one of them with mediaquery)
+  // We don't return "undefined" on purpose, to make it more explicit
+  ssr: 'ssr',
 } as const;
 
-function useWindowSize(): WindowSize | undefined {
-  const isClient = ExecutionEnvironment.canUseDOM;
+const DesktopThresholdWidth = 996;
 
-  function getSize() {
-    if (!isClient) {
-      return undefined;
-    }
-    return window.innerWidth > desktopThresholdWidth
-      ? windowSizes.desktop
-      : windowSizes.mobile;
+function getWindowSize() {
+  if (!ExecutionEnvironment.canUseDOM) {
+    return windowSizes.ssr;
   }
+  return window.innerWidth > DesktopThresholdWidth
+    ? windowSizes.desktop
+    : windowSizes.mobile;
+}
 
-  const [windowSize, setWindowSize] = useState(getSize);
+// Simulate the SSR window size in dev, so that potential hydration FOUC/layout shift problems can be seen in dev too!
+const DevSimulateSSR = process.env.NODE_ENV === 'development' && true;
 
-  useEffect(() => {
-    if (!isClient) {
-      return undefined;
+// This hook returns an enum value on purpose!
+// We don't want it to return the actual width value, for resize perf reasons
+// We only want to re-render once a breakpoint is crossed
+function useWindowSize(): WindowSize {
+  const [windowSize, setWindowSize] = useState<WindowSize>(() => {
+    if (DevSimulateSSR) {
+      return 'ssr';
     }
+    return getWindowSize();
+  });
 
-    function handleResize() {
-      setWindowSize(getSize());
+  useEffect(() => {
+    function updateWindowSize() {
+      setWindowSize(getWindowSize());
     }
 
-    window.addEventListener('resize', handleResize);
-    return () => window.removeEventListener('resize', handleResize);
+    const timeout = DevSimulateSSR
+      ? window.setTimeout(updateWindowSize, 1000)
+      : undefined;
+
+    window.addEventListener('resize', updateWindowSize);
+
+    return () => {
+      window.removeEventListener('resize', updateWindowSize);
+      clearTimeout(timeout);
+    };
   }, []);
 
   return windowSize;
 }
 
-export {windowSizes};
 export default useWindowSize;

package/src/theme/prism-include-languages.ts

@@ -12,12 +12,13 @@ import type * as PrismNamespace from 'prismjs';
 const prismIncludeLanguages = (PrismObject: typeof PrismNamespace): void => {
   if (ExecutionEnvironment.canUseDOM) {
     const {
-      themeConfig: {prism: {additionalLanguages = []} = {}},
+      themeConfig: {prism = {}},
     } = siteConfig;
+    const {additionalLanguages = []} = prism as {additionalLanguages: string[]};
 
     window.Prism = PrismObject;
 
-    additionalLanguages.forEach((lang: string) => {
+    additionalLanguages.forEach((lang) => {
       require(`prismjs/components/prism-${lang}`); // eslint-disable-line
     });
 

package/src/translations.ts

@@ -13,18 +13,16 @@ import {
   Footer,
 } from '@docusaurus/theme-common';
 
-import {keyBy, chain, flatten} from 'lodash';
+import {keyBy, chain} from 'lodash';
 import {mergeTranslations} from '@docusaurus/utils';
 
 function getNavbarTranslationFile(navbar: Navbar): TranslationFileContent {
   // TODO handle properly all the navbar item types here!
   function flattenNavbarItems(items: NavbarItem[]): NavbarItem[] {
-    const subItems = flatten(
-      items.map((item) => {
-        const allSubItems = flatten([item.items ?? []]);
-        return flattenNavbarItems(allSubItems);
-      }),
-    );
+    const subItems = items.flatMap((item) => {
+      const allSubItems = [item.items ?? []].flat();
+      return flattenNavbarItems(allSubItems);
+    });
     return [...items, ...subItems];
   }
 
@@ -84,9 +82,7 @@ function getFooterTranslationFile(footer: Footer): TranslationFileContent {
     .value();
 
   const footerLinkLabels: TranslationFileContent = chain(
-    flatten(footer.links.map((link) => link.items)).filter(
-      (link) => !!link.label,
-    ),
+    footer.links.flatMap((link) => link.items).filter((link) => !!link.label),
   )
     .keyBy((linkItem) => `link.item.label.${linkItem.label}`)
     .mapValues((linkItem) => ({