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

package/lib-next/theme/Toggle/index.js

@@ -6,19 +6,18 @@
  */
 import React, {useState, useRef, memo} from 'react';
 import {useThemeConfig} from '@docusaurus/theme-common';
-import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
+import useIsBrowser from '@docusaurus/useIsBrowser';
 import clsx from 'clsx';
-import './styles.css';
 import styles from './styles.module.css';
 
 const Dark = ({icon, style}) => (
-  <span className={clsx(styles.toggle, styles.dark)} style={style}>
+  <span className={clsx(styles.toggleIcon, styles.dark)} style={style}>
     {icon}
   </span>
 );
 
 const Light = ({icon, style}) => (
-  <span className={clsx(styles.toggle, styles.light)} style={style}>
+  <span className={clsx(styles.toggleIcon, styles.light)} style={style}>
     {icon}
   </span>
 ); // Based on react-toggle (https://github.com/aaronshaf/react-toggle/).
@@ -30,31 +29,37 @@ const Toggle = memo(
     const inputRef = useRef(null);
     return (
       <div
-        className={clsx('react-toggle', className, {
-          'react-toggle--checked': checked,
-          'react-toggle--focus': focused,
-          'react-toggle--disabled': disabled,
+        className={clsx(styles.toggle, className, {
+          [styles.toggleChecked]: checked,
+          [styles.toggleFocused]: focused,
+          [styles.toggleDisabled]: disabled,
         })}>
+        {/* eslint-disable-next-line jsx-a11y/click-events-have-key-events */}
         <div
-          className="react-toggle-track"
+          className={styles.toggleTrack}
           role="button"
           tabIndex={-1}
           onClick={() => inputRef.current?.click()}>
-          <div className="react-toggle-track-check">{icons.checked}</div>
-          <div className="react-toggle-track-x">{icons.unchecked}</div>
-          <div className="react-toggle-thumb" />
+          <div className={styles.toggleTrackCheck}>{icons.checked}</div>
+          <div className={styles.toggleTrackX}>{icons.unchecked}</div>
+          <div className={styles.toggleTrackThumb} />
         </div>
 
         <input
           ref={inputRef}
           checked={checked}
           type="checkbox"
-          className="react-toggle-screenreader-only"
+          className={styles.toggleScreenReader}
           aria-label="Switch between dark and light mode"
           onChange={onChange}
           onClick={() => setChecked(!checked)}
           onFocus={() => setFocused(true)}
           onBlur={() => setFocused(false)}
+          onKeyDown={(e) => {
+            if (e.key === 'Enter') {
+              inputRef.current?.click();
+            }
+          }}
         />
       </div>
     );
@@ -66,10 +71,10 @@ export default function (props) {
       switchConfig: {darkIcon, darkIconStyle, lightIcon, lightIconStyle},
     },
   } = useThemeConfig();
-  const {isClient} = useDocusaurusContext();
+  const isBrowser = useIsBrowser();
   return (
     <Toggle
-      disabled={!isClient}
+      disabled={!isBrowser}
       icons={{
         checked: <Dark icon={darkIcon} style={darkIconStyle} />,
         unchecked: <Light icon={lightIcon} style={lightIconStyle} />,

package/lib-next/theme/Toggle/styles.module.css

@@ -6,6 +6,97 @@
  */
 
 .toggle {
+  touch-action: pan-x;
+  position: relative;
+  cursor: pointer;
+  user-select: none;
+  -webkit-tap-highlight-color: transparent;
+}
+
+.toggleScreenReader {
+  border: 0;
+  clip: rect(0 0 0 0);
+  height: 1px;
+  margin: -1px;
+  overflow: hidden;
+  position: absolute;
+  width: 1px;
+}
+
+.toggleDisabled {
+  cursor: not-allowed;
+}
+
+.toggleTrack {
+  width: 50px;
+  height: 24px;
+  border-radius: 30px;
+  background-color: #4d4d4d;
+  transition: all 0.2s ease;
+}
+
+.toggleTrackCheck {
+  position: absolute;
+  width: 14px;
+  height: 10px;
+  top: 0px;
+  bottom: 0px;
+  margin: auto 0;
+  left: 8px;
+  opacity: 0;
+  transition: opacity 0.25s ease;
+}
+
+[data-theme='dark'] .toggle .toggleTrackCheck,
+.toggleChecked .toggleTrackCheck {
+  opacity: 1;
+  transition: opacity 0.25s ease;
+}
+
+.toggleTrackX {
+  position: absolute;
+  width: 10px;
+  height: 10px;
+  top: 0px;
+  bottom: 0px;
+  margin: auto 0;
+  right: 10px;
+  opacity: 1;
+  transition: opacity 0.25s ease;
+}
+
+[data-theme='dark'] .toggle .toggleTrackX,
+.toggleChecked .toggleTrackX {
+  opacity: 0;
+}
+
+.toggleTrackThumb {
+  position: absolute;
+  top: 1px;
+  left: 1px;
+  width: 22px;
+  height: 22px;
+  border: 1px solid #4d4d4d;
+  border-radius: 50%;
+  background-color: #fafafa;
+  transition: all 0.25s ease;
+}
+
+[data-theme='dark'] .toggle .toggleTrackThumb,
+.toggleChecked .toggleTrackThumb {
+  left: 27px;
+}
+
+.toggleFocused .toggleTrackThumb,
+.toggle:hover .toggleTrackThumb {
+  box-shadow: 0px 0px 2px 3px var(--ifm-color-primary);
+}
+
+.toggle:active:not(.toggleDisabled) .toggleTrackThumb {
+  box-shadow: 0px 0px 5px 5px var(--ifm-color-primary);
+}
+
+.toggleIcon {
   align-items: center;
   display: flex;
   height: 10px;

package/lib-next/theme/UserPreferencesProvider/index.js

@@ -6,19 +6,15 @@
  */
 import React from 'react';
 import useTabGroupChoice from '@theme/hooks/useTabGroupChoice';
-import useAnnouncementBar from '@theme/hooks/useAnnouncementBar';
 import UserPreferencesContext from '@theme/UserPreferencesContext';
 
 function UserPreferencesProvider(props) {
   const {tabGroupChoices, setTabGroupChoices} = useTabGroupChoice();
-  const {isAnnouncementBarClosed, closeAnnouncementBar} = useAnnouncementBar();
   return (
     <UserPreferencesContext.Provider
       value={{
         tabGroupChoices,
         setTabGroupChoices,
-        isAnnouncementBarClosed,
-        closeAnnouncementBar,
       }}>
       {props.children}
     </UserPreferencesContext.Provider>

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

@@ -4,72 +4,59 @@
  * This source code is licensed under the MIT license found in the
  * 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';
 
 const useHideableNavbar = (hideOnScroll) => {
-  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) => {
     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;
-      }
+  useScrollPosition((currentPosition, lastPosition) => {
+    if (!hideOnScroll) {
+      return;
+    }
 
-      if (lastScrollTop && scrollTop === 0) {
-        setIsNavbarVisible(true);
-      }
+    const scrollTop = currentPosition.scrollY; // It needed for mostly to handle rubber band scrolling
 
-      const documentHeight =
-        document.documentElement.scrollHeight - navbarHeight;
-      const windowHeight = window.innerHeight;
+    if (scrollTop < navbarHeight.current) {
+      setIsNavbarVisible(true);
+      return;
+    }
 
-      if (lastScrollTop && scrollTop >= lastScrollTop) {
-        setIsNavbarVisible(false);
-      } else if (scrollTop + windowHeight < documentHeight) {
-        setIsNavbarVisible(true);
-      }
-    },
-    [navbarHeight, isFocusedAnchor],
-  );
-  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,
     isNavbarVisible,

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

@@ -16,14 +16,12 @@ const useTabGroupChoice = () => {
   useEffect(() => {
     try {
       const localStorageChoices = {};
-
-      for (const storageKey of listStorageKeys()) {
+      listStorageKeys().forEach((storageKey) => {
         if (storageKey.startsWith(TAB_CHOICE_PREFIX)) {
           const groupId = storageKey.substring(TAB_CHOICE_PREFIX.length);
           localStorageChoices[groupId] = createStorageSlot(storageKey).get();
         }
-      }
-
+      });
       setChoices(localStorageChoices);
     } catch (err) {
       console.error(err);

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

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

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

package/lib-next/translations.js

@@ -4,18 +4,16 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import {keyBy, chain, flatten} from 'lodash';
+import {keyBy, chain} from 'lodash';
 import {mergeTranslations} from '@docusaurus/utils';
 
 function getNavbarTranslationFile(navbar) {
   // TODO handle properly all the navbar item types here!
   function flattenNavbarItems(items) {
-    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];
   }
 
@@ -76,9 +74,7 @@ function getFooterTranslationFile(footer) {
     }))
     .value();
   const footerLinkLabels = 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) => ({