@docusaurus/theme-classic 2.0.0-beta.12faed89d → 2.0.0-beta.14

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

@@ -6,74 +6,71 @@
  */
 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';
+import styles from './styles.module.css'; // Based on react-toggle (https://github.com/aaronshaf/react-toggle/).
 
-const Dark = ({icon, style}) => (
-  <span className={clsx(styles.toggle, styles.dark)} style={style}>
-    {icon}
-  </span>
-);
-
-const Light = ({icon, style}) => (
-  <span className={clsx(styles.toggle, styles.light)} style={style}>
-    {icon}
-  </span>
-); // Based on react-toggle (https://github.com/aaronshaf/react-toggle/).
-
-const Toggle = memo(
-  ({className, icons, checked: defaultChecked, disabled, onChange}) => {
+const ToggleComponent = memo(
+  ({className, switchConfig, checked: defaultChecked, disabled, onChange}) => {
+    const {darkIcon, darkIconStyle, lightIcon, lightIconStyle} = switchConfig;
     const [checked, setChecked] = useState(defaultChecked);
     const [focused, setFocused] = useState(false);
     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}>
+            <span className={styles.toggleIcon} style={darkIconStyle}>
+              {darkIcon}
+            </span>
+          </div>
+          <div className={styles.toggleTrackX}>
+            <span className={styles.toggleIcon} style={lightIconStyle}>
+              {lightIcon}
+            </span>
+          </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>
     );
   },
 );
-export default function (props) {
+export default function Toggle(props) {
   const {
-    colorMode: {
-      switchConfig: {darkIcon, darkIconStyle, lightIcon, lightIconStyle},
-    },
+    colorMode: {switchConfig},
   } = useThemeConfig();
-  const {isClient} = useDocusaurusContext();
+  const isBrowser = useIsBrowser();
   return (
-    <Toggle
-      disabled={!isClient}
-      icons={{
-        checked: <Dark icon={darkIcon} style={darkIconStyle} />,
-        unchecked: <Light icon={lightIcon} style={lightIconStyle} />,
-      }}
+    <ToggleComponent
+      switchConfig={switchConfig}
+      disabled={!isBrowser}
       {...props}
     />
   );

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

@@ -6,12 +6,100 @@
  */
 
 .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;
   justify-content: center;
   width: 10px;
 }
-.toggle::before {
-  position: absolute;
-}

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

@@ -4,18 +4,21 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import React from 'react';
+import React, {useMemo} from 'react';
 import useTabGroupChoice from '@theme/hooks/useTabGroupChoice';
 import UserPreferencesContext from '@theme/UserPreferencesContext';
 
 function UserPreferencesProvider(props) {
   const {tabGroupChoices, setTabGroupChoices} = useTabGroupChoice();
+  const contextValue = useMemo(
+    () => ({
+      tabGroupChoices,
+      setTabGroupChoices,
+    }),
+    [tabGroupChoices, setTabGroupChoices],
+  );
   return (
-    <UserPreferencesContext.Provider
-      value={{
-        tabGroupChoices,
-        setTabGroupChoices,
-      }}>
+    <UserPreferencesContext.Provider value={contextValue}>
       {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/useTheme.js

@@ -14,9 +14,8 @@ const themes = {
 };
 
 // Ensure to always return a valid theme even if input is invalid
-const coerceToTheme = (theme) => {
-  return theme === themes.dark ? themes.dark : themes.light;
-};
+const coerceToTheme = (theme) =>
+  theme === themes.dark ? themes.dark : themes.light;
 
 const getInitialTheme = (defaultMode) => {
   if (!ExecutionEnvironment.canUseDOM) {
@@ -60,7 +59,7 @@ const useTheme = () => {
     } catch (err) {
       console.error(err);
     }
-  }, [setTheme]);
+  }, [disableSwitch, setTheme]);
   useEffect(() => {
     if (disableSwitch && !respectPrefersColorScheme) {
       return;
@@ -71,7 +70,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

@@ -40,16 +40,12 @@ function useWindowSize() {
     return getWindowSize();
   });
   useEffect(() => {
-    if (!ExecutionEnvironment.canUseDOM) {
-      return undefined;
-    }
-
     function updateWindowSize() {
       setWindowSize(getWindowSize());
-    } // @ts-expect-error: annoying TS setTimeout typing...
+    }
 
     const timeout = DevSimulateSSR
-      ? setTimeout(updateWindowSize, 1000)
+      ? window.setTimeout(updateWindowSize, 1000)
       : undefined;
     window.addEventListener('resize', updateWindowSize);
     return () => {

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/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@docusaurus/theme-classic",
-  "version": "2.0.0-beta.12faed89d",
+  "version": "2.0.0-beta.14",
   "description": "Classic theme for Docusaurus",
   "main": "lib/index.js",
-  "types": "src/types.d.ts",
+  "types": "src/theme-classic.d.ts",
   "publishConfig": {
     "access": "public"
   },
@@ -14,50 +14,52 @@
   },
   "license": "MIT",
   "scripts": {
-    "build": "tsc --noEmit && yarn babel:lib && yarn babel:lib-next && yarn prettier:lib-next",
+    "build": "tsc --noEmit && yarn babel:lib && yarn babel:lib-next && yarn format:lib-next",
     "watch": "concurrently --names \"lib,lib-next,tsc\" --kill-others \"yarn babel:lib --watch\" \"yarn babel:lib-next --watch\" \"yarn tsc --watch\"",
     "babel:lib": "cross-env BABEL_ENV=lib babel src -d lib --extensions \".tsx,.ts\" --ignore \"**/*.d.ts\" --copy-files",
     "babel:lib-next": "cross-env BABEL_ENV=lib-next babel src -d lib-next --extensions \".tsx,.ts\" --ignore \"**/*.d.ts\" --copy-files",
-    "prettier": "prettier --config ../../.prettierrc --ignore-path ../../.prettierignore --write \"**/*.{js,ts,jsx,tsc}\"",
-    "prettier:lib-next": "prettier --config ../../.prettierrc --write \"lib-next/**/*.{js,ts,jsx,tsc}\"",
+    "format": "prettier --config ../../.prettierrc --ignore-path ../../.prettierignore --write \"**/*.{js,ts,jsx,tsc}\"",
+    "format:lib-next": "prettier --config ../../.prettierrc --write \"lib-next/**/*.{js,ts,jsx,tsc}\"",
     "update-code-translations": "node -e 'require(\"./update-code-translations.js\").run()'"
   },
   "dependencies": {
-    "@docusaurus/core": "2.0.0-beta.12faed89d",
-    "@docusaurus/plugin-content-blog": "2.0.0-beta.12faed89d",
-    "@docusaurus/plugin-content-docs": "2.0.0-beta.12faed89d",
-    "@docusaurus/plugin-content-pages": "2.0.0-beta.12faed89d",
-    "@docusaurus/theme-common": "2.0.0-beta.12faed89d",
-    "@docusaurus/types": "2.0.0-beta.12faed89d",
-    "@docusaurus/utils": "2.0.0-beta.12faed89d",
-    "@docusaurus/utils-common": "2.0.0-beta.12faed89d",
-    "@docusaurus/utils-validation": "2.0.0-beta.12faed89d",
+    "@docusaurus/core": "2.0.0-beta.14",
+    "@docusaurus/plugin-content-blog": "2.0.0-beta.14",
+    "@docusaurus/plugin-content-docs": "2.0.0-beta.14",
+    "@docusaurus/plugin-content-pages": "2.0.0-beta.14",
+    "@docusaurus/theme-common": "2.0.0-beta.14",
+    "@docusaurus/theme-translations": "2.0.0-beta.14",
+    "@docusaurus/utils": "2.0.0-beta.14",
+    "@docusaurus/utils-validation": "2.0.0-beta.14",
     "@mdx-js/mdx": "^1.6.21",
     "@mdx-js/react": "^1.6.21",
-    "chalk": "^4.1.1",
     "clsx": "^1.1.1",
     "copy-text-to-clipboard": "^3.0.1",
-    "fs-extra": "^10.0.0",
     "globby": "^11.0.2",
-    "infima": "0.2.0-alpha.26",
+    "infima": "0.2.0-alpha.37",
     "lodash": "^4.17.20",
-    "parse-numeric-range": "^1.2.0",
-    "postcss": "^8.2.15",
+    "postcss": "^8.3.7",
     "prism-react-renderer": "^1.2.1",
     "prismjs": "^1.23.0",
-    "prop-types": "^15.7.2",
     "react-router-dom": "^5.2.0",
-    "rtlcss": "^3.1.2"
+    "rtlcss": "^3.3.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "2.0.0-beta.12faed89d"
+    "@docusaurus/module-type-aliases": "2.0.0-beta.14",
+    "@docusaurus/types": "2.0.0-beta.14",
+    "@types/mdx-js__react": "^1.5.4",
+    "@types/parse-numeric-range": "^0.0.1",
+    "@types/rtlcss": "^3.1.1",
+    "fs-extra": "^10.0.0",
+    "react-test-renderer": "^17.0.2",
+    "utility-types": "^3.10.0"
   },
   "peerDependencies": {
     "react": "^16.8.4 || ^17.0.0",
     "react-dom": "^16.8.4 || ^17.0.0"
   },
   "engines": {
-    "node": ">=12.13.0"
+    "node": ">=14"
   },
-  "gitHead": "1430dbacfbe9da59a17ce395ed29bdbddaf90049"
+  "gitHead": "c4824a8937d8f1aa0806667749cbc74058e2b294"
 }

package/src/admonitions.css

@@ -0,0 +1,35 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+.admonition h5 {
+  margin-top: 0;
+  margin-bottom: 8px;
+  text-transform: uppercase;
+}
+
+.admonition-icon {
+  display: inline-block;
+  vertical-align: middle;
+  margin-right: 0.4em;
+}
+
+.admonition-icon svg {
+  display: inline-block;
+  width: 22px;
+  height: 22px;
+  stroke-width: 0;
+  fill: var(--ifm-alert-foreground-color);
+  stroke: var(--ifm-alert-foreground-color);
+}
+
+.admonition-content > :last-child {
+  margin-bottom: 0;
+}
+
+.admonition {
+  margin-bottom: 1em;
+}

package/src/deps.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+declare module 'prism-react-renderer/prism' {
+  import type * as PrismNamespace from 'prismjs';
+
+  const Prism: typeof PrismNamespace;
+  export default Prism;
+}

package/src/index.ts

@@ -5,16 +5,16 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import {DocusaurusContext, Plugin} from '@docusaurus/types';
+import {DocusaurusContext, Plugin, PostCssOptions} from '@docusaurus/types';
 import type {ThemeConfig} from '@docusaurus/theme-common';
 import {getTranslationFiles, translateThemeConfig} from './translations';
 import path from 'path';
-import Module from 'module';
-import type {AcceptedPlugin, Result, Plugin as PostCssPlugin} from 'postcss';
+import {createRequire} from 'module';
+import type {Plugin as PostCssPlugin} from 'postcss';
 import rtlcss from 'rtlcss';
-import {readDefaultCodeTranslationMessages} from '@docusaurus/utils';
+import {readDefaultCodeTranslationMessages} from '@docusaurus/theme-translations';
+import type {Options} from '@docusaurus/theme-classic';
 
-const createRequire = Module.createRequire || Module.createRequireFromPath;
 const requireFromDocusaurusCore = createRequire(
   require.resolve('@docusaurus/core/package.json'),
 );
@@ -25,8 +25,10 @@ const ContextReplacementPlugin = requireFromDocusaurusCore(
 // Need to be inlined to prevent dark mode FOUC
 // Make sure that the 'storageKey' is the same as the one in `/theme/hooks/useTheme.js`
 const ThemeStorageKey = 'theme';
-const noFlashColorMode = ({defaultMode, respectPrefersColorScheme}) => {
-  return `(function() {
+const noFlashColorMode = ({
+  defaultMode,
+  respectPrefersColorScheme,
+}: ThemeConfig['colorMode']) => `(function() {
   var defaultMode = '${defaultMode}';
   var respectPrefersColorScheme = ${respectPrefersColorScheme};
 
@@ -61,7 +63,6 @@ const noFlashColorMode = ({defaultMode, respectPrefersColorScheme}) => {
     }
   }
 })();`;
-};
 
 // Duplicated constant. Unfortunately we can't import it from theme-common, as we need to support older nodejs versions without ESM support
 // TODO: import from theme-common once we only support Node.js with ESM support
@@ -83,19 +84,15 @@ const AnnouncementBarInlineJavaScript = `
   document.documentElement.setAttribute('${AnnouncementBarDismissDataAttribute}', isDismissed());
 })();`;
 
-function getInfimaCSSFile(direction) {
+function getInfimaCSSFile(direction: string) {
   return `infima/dist/css/default/default${
     direction === 'rtl' ? '-rtl' : ''
   }.css`;
 }
 
-type PluginOptions = {
-  customCss?: string;
-};
-
 export default function docusaurusThemeClassic(
   context: DocusaurusContext, // TODO: LoadContext is missing some of properties
-  options: PluginOptions,
+  options: Options,
 ): Plugin<void> {
   const {
     siteConfig: {themeConfig: roughlyTypedThemeConfig},
@@ -132,12 +129,17 @@ export default function docusaurusThemeClassic(
     },
 
     getTranslationFiles: async () => getTranslationFiles({themeConfig}),
-    translateThemeConfig,
 
-    getDefaultCodeTranslationMessages: () => {
+    translateThemeConfig: (params) =>
+      translateThemeConfig({
+        themeConfig: params.themeConfig as ThemeConfig,
+        translationFiles: params.translationFiles,
+      }),
+
+    getDefaultCodeTranslationMessages() {
       return readDefaultCodeTranslationMessages({
-        dirPath: path.resolve(__dirname, '..', 'codeTranslations'),
         locale: currentLocale,
+        name: 'theme-common',
       });
     },
 
@@ -145,6 +147,7 @@ export default function docusaurusThemeClassic(
       const modules = [
         require.resolve(getInfimaCSSFile(direction)),
         path.resolve(__dirname, './prism-include-languages'),
+        path.resolve(__dirname, './admonitions.css'),
       ];
 
       if (customCss) {
@@ -177,18 +180,18 @@ export default function docusaurusThemeClassic(
       };
     },
 
-    configurePostCss(postCssOptions: {plugins: AcceptedPlugin[]}) {
+    configurePostCss(postCssOptions: PostCssOptions) {
       if (direction === 'rtl') {
         const resolvedInfimaFile = require.resolve(getInfimaCSSFile(direction));
         const plugin: PostCssPlugin = {
           postcssPlugin: 'RtlCssPlugin',
-          prepare: (result: Result) => {
+          prepare: (result) => {
             const file = result.root?.source?.input?.file;
             // Skip Infima as we are using the its RTL version.
             if (file === resolvedInfimaFile) {
               return {};
             }
-            return rtlcss(result.root);
+            return rtlcss(result.root as unknown as rtlcss.ConfigOptions);
           },
         };
         postCssOptions.plugins.push(plugin);