@docusaurus/theme-classic 2.0.0-beta.0f144213d → 2.0.0-beta.11

package/lib-next/theme/hooks/useWindowSize.js

@@ -6,40 +6,54 @@
  */
 import {useEffect, useState} from 'react';
 import ExecutionEnvironment from '@docusaurus/ExecutionEnvironment';
-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',
 };
+const DesktopThresholdWidth = 996;
 
-function useWindowSize() {
-  const isClient = ExecutionEnvironment.canUseDOM;
+function getWindowSize() {
+  if (!ExecutionEnvironment.canUseDOM) {
+    return windowSizes.ssr;
+  }
 
-  function getSize() {
-    if (!isClient) {
-      return undefined;
-    }
+  return window.innerWidth > DesktopThresholdWidth
+    ? windowSizes.desktop
+    : windowSizes.mobile;
+} // Simulate the SSR window size in dev, so that potential hydration FOUC/layout shift problems can be seen in dev too!
 
-    return window.innerWidth > desktopThresholdWidth
-      ? windowSizes.desktop
-      : windowSizes.mobile;
-  }
+const DevSimulateSSR = process.env.NODE_ENV === 'development' && true; // 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
 
-  const [windowSize, setWindowSize] = useState(getSize);
-  useEffect(() => {
-    if (!isClient) {
-      return undefined;
+function useWindowSize() {
+  const [windowSize, setWindowSize] = useState(() => {
+    if (DevSimulateSSR) {
+      return 'ssr';
     }
 
-    function handleResize() {
-      setWindowSize(getSize());
+    return getWindowSize();
+  });
+  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/lib-next/theme/prism-include-languages.js

@@ -10,8 +10,9 @@ import siteConfig from '@generated/docusaurus.config';
 const prismIncludeLanguages = (PrismObject) => {
   if (ExecutionEnvironment.canUseDOM) {
     const {
-      themeConfig: {prism: {additionalLanguages = []} = {}},
+      themeConfig: {prism = {}},
     } = siteConfig;
+    const {additionalLanguages = []} = prism;
     window.Prism = PrismObject;
     additionalLanguages.forEach((lang) => {
       require(`prismjs/components/prism-${lang}`); // eslint-disable-line