@docusaurus/theme-classic 2.0.0-beta.fc64c12e4 → 2.0.0

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

@@ -1,41 +0,0 @@
-/**
- * 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.
- */
-import React from 'react';
-import clsx from 'clsx';
-import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
-import useThemeContext from '@theme/hooks/useThemeContext';
-import styles from './styles.module.css';
-
-const ThemedImage = (props) => {
-  const {isClient} = useDocusaurusContext();
-  const {isDarkTheme} = useThemeContext();
-  const {sources, className, alt = '', ...propsRest} = props;
-  const clientThemes = isDarkTheme ? ['dark'] : ['light'];
-  const renderedSourceNames = isClient
-    ? clientThemes // We need to render both images on the server to avoid flash
-    : // See https://github.com/facebook/docusaurus/pull/3730
-      ['light', 'dark'];
-  return (
-    <>
-      {renderedSourceNames.map((sourceName) => (
-        <img
-          key={sourceName}
-          src={sources[sourceName]}
-          alt={alt}
-          className={clsx(
-            styles.themedImage,
-            styles[`themedImage--${sourceName}`],
-            className,
-          )}
-          {...propsRest}
-        />
-      ))}
-    </>
-  );
-};
-
-export default ThemedImage;

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

@@ -1,18 +0,0 @@
-/**
- * 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.
- */
-
-.themedImage {
-  display: none;
-}
-
-html[data-theme='light'] .themedImage--light {
-  display: initial;
-}
-
-html[data-theme='dark'] .themedImage--dark {
-  display: initial;
-}

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

@@ -1,80 +0,0 @@
-/**
- * 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.
- */
-import React, {useState, useRef, memo} from 'react';
-import {useThemeConfig} from '@docusaurus/theme-common';
-import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
-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}>
-    {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 [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,
-        })}>
-        <div
-          className="react-toggle-track"
-          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>
-
-        <input
-          ref={inputRef}
-          checked={checked}
-          type="checkbox"
-          className="react-toggle-screenreader-only"
-          aria-label="Switch between dark and light mode"
-          onChange={onChange}
-          onClick={() => setChecked(!checked)}
-          onFocus={() => setFocused(true)}
-          onBlur={() => setFocused(false)}
-        />
-      </div>
-    );
-  },
-);
-export default function (props) {
-  const {
-    colorMode: {
-      switchConfig: {darkIcon, darkIconStyle, lightIcon, lightIconStyle},
-    },
-  } = useThemeConfig();
-  const {isClient} = useDocusaurusContext();
-  return (
-    <Toggle
-      disabled={!isClient}
-      icons={{
-        checked: <Dark icon={darkIcon} style={darkIconStyle} />,
-        unchecked: <Light icon={lightIcon} style={lightIconStyle} />,
-      }}
-      {...props}
-    />
-  );
-}

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

@@ -1,103 +0,0 @@
-/**
- * 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.
- */
-
-/**
- * Styles for React Toggle
- * copied over because we want to allow user to swizzle it and modify the css
- * and also to make sure its compatible with our dark mode
- * https://github.com/aaronshaf/react-toggle/blob/master/style.css
- */
-.react-toggle {
-  touch-action: pan-x;
-  position: relative;
-  cursor: pointer;
-  user-select: none;
-  -webkit-tap-highlight-color: transparent;
-}
-
-.react-toggle-screenreader-only {
-  border: 0;
-  clip: rect(0 0 0 0);
-  height: 1px;
-  margin: -1px;
-  overflow: hidden;
-  position: absolute;
-  width: 1px;
-}
-
-.react-toggle--disabled {
-  cursor: not-allowed;
-}
-
-.react-toggle-track {
-  width: 50px;
-  height: 24px;
-  border-radius: 30px;
-  background-color: #4d4d4d;
-  transition: all 0.2s ease;
-}
-
-.react-toggle-track-check {
-  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'] .react-toggle .react-toggle-track-check,
-.react-toggle--checked .react-toggle-track-check {
-  opacity: 1;
-  transition: opacity 0.25s ease;
-}
-
-.react-toggle-track-x {
-  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'] .react-toggle .react-toggle-track-x,
-.react-toggle--checked .react-toggle-track-x {
-  opacity: 0;
-}
-
-.react-toggle-thumb {
-  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'] .react-toggle .react-toggle-thumb,
-.react-toggle--checked .react-toggle-thumb {
-  left: 27px;
-}
-
-.react-toggle--focus .react-toggle-thumb,
-.react-toggle:hover .react-toggle-thumb {
-  box-shadow: 0px 0px 2px 3px var(--ifm-color-primary);
-}
-
-.react-toggle:active:not(.react-toggle--disabled) .react-toggle-thumb {
-  box-shadow: 0px 0px 5px 5px var(--ifm-color-primary);
-}

package/lib-next/theme/UserPreferencesContext.js

@@ -1,9 +0,0 @@
-/**
- * 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.
- */
-import {createContext} from 'react';
-const UserPreferencesContext = createContext(undefined);
-export default UserPreferencesContext;

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

@@ -1,24 +0,0 @@
-/**
- * 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.
- */
-import React from 'react';
-import useTabGroupChoice from '@theme/hooks/useTabGroupChoice';
-import UserPreferencesContext from '@theme/UserPreferencesContext';
-
-function UserPreferencesProvider(props) {
-  const {tabGroupChoices, setTabGroupChoices} = useTabGroupChoice();
-  return (
-    <UserPreferencesContext.Provider
-      value={{
-        tabGroupChoices,
-        setTabGroupChoices,
-      }}>
-      {props.children}
-    </UserPreferencesContext.Provider>
-  );
-}
-
-export default UserPreferencesProvider;

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

@@ -1,41 +0,0 @@
-/**
- * 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.
- */
-import {useAllDocsData, useActivePluginAndVersion} from '@theme/hooks/useDocs';
-import {
-  useDocsPreferredVersionByPluginId,
-  DEFAULT_SEARCH_TAG,
-  docVersionSearchTag,
-} from '@docusaurus/theme-common';
-import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
-// We may want to support multiple search engines, don't couple that to Algolia/DocSearch
-// Maybe users will want to use its own search engine solution
-export default function useContextualSearchFilters() {
-  const {i18n} = useDocusaurusContext();
-  const allDocsData = useAllDocsData();
-  const activePluginAndVersion = useActivePluginAndVersion();
-  const docsPreferredVersionByPluginId = useDocsPreferredVersionByPluginId();
-
-  function getDocPluginTags(pluginId) {
-    const activeVersion =
-      activePluginAndVersion?.activePlugin?.pluginId === pluginId
-        ? activePluginAndVersion.activeVersion
-        : undefined;
-    const preferredVersion = docsPreferredVersionByPluginId[pluginId];
-    const latestVersion = allDocsData[pluginId].versions.find((v) => v.isLast);
-    const version = activeVersion ?? preferredVersion ?? latestVersion;
-    return docVersionSearchTag(pluginId, version.name);
-  }
-
-  const tags = [
-    DEFAULT_SEARCH_TAG,
-    ...Object.keys(allDocsData).map(getDocPluginTags),
-  ];
-  return {
-    locale: i18n.currentLocale,
-    tags,
-  };
-}

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

@@ -1,10 +0,0 @@
-/**
- * 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.
- */
-// Re-expose useDocs
-// Ensure it's always statically available even if user is not using the docs plugin
-// Problem reported for the blog-only mode: https://github.com/facebook/docusaurus/issues/3360
-export * from '@docusaurus/plugin-content-docs/lib/theme/hooks/useDocs';

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

@@ -1,82 +0,0 @@
-/**
- * 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.
- */
-import {useState, useCallback, useEffect, useRef} from 'react';
-import {useLocation} from '@docusaurus/router';
-import useScrollPosition from '@theme/hooks/useScrollPosition';
-import {useLocationChange} 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 navbarRef = useCallback((node) => {
-    if (node !== null) {
-      setNavbarHeight(node.getBoundingClientRect().height);
-    }
-  }, []);
-  useScrollPosition(
-    (currentPosition, lastPosition) => {
-      const scrollTop = currentPosition.scrollY;
-      const lastScrollTop = lastPosition?.scrollY;
-
-      if (!hideOnScroll) {
-        return;
-      }
-
-      if (scrollTop < navbarHeight) {
-        setIsNavbarVisible(true);
-        return;
-      }
-
-      if (isFocusedAnchor.current) {
-        isFocusedAnchor.current = false;
-        setIsNavbarVisible(false);
-        return;
-      }
-
-      if (lastScrollTop && scrollTop === 0) {
-        setIsNavbarVisible(true);
-      }
-
-      const documentHeight =
-        document.documentElement.scrollHeight - navbarHeight;
-      const windowHeight = window.innerHeight;
-
-      if (lastScrollTop && scrollTop >= lastScrollTop) {
-        setIsNavbarVisible(false);
-      } else if (scrollTop + windowHeight < documentHeight) {
-        setIsNavbarVisible(true);
-      }
-    },
-    [navbarHeight, isFocusedAnchor],
-  );
-  useLocationChange((locationChangeEvent) => {
-    if (!hideOnScroll || locationChangeEvent.location.hash) {
-      return;
-    }
-
-    setIsNavbarVisible(true);
-  });
-  useEffect(() => {
-    if (!hideOnScroll) {
-      return;
-    }
-
-    if (!location.hash) {
-      return;
-    }
-
-    isFocusedAnchor.current = true;
-  }, [location.hash]);
-  return {
-    navbarRef,
-    isNavbarVisible,
-  };
-};
-
-export default useHideableNavbar;

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

@@ -1,35 +0,0 @@
-/**
- * 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.
- */
-import {useEffect} from 'react';
-import './styles.css'; // This hook detect keyboard focus indicator to not show outline for mouse users
-// Inspired by https://hackernoon.com/removing-that-ugly-focus-ring-and-keeping-it-too-6c8727fefcd2
-
-function useKeyboardNavigation() {
-  useEffect(() => {
-    const keyboardFocusedClassName = 'navigation-with-keyboard';
-
-    function handleOutlineStyles(e) {
-      if (e.type === 'keydown' && e.key === 'Tab') {
-        document.body.classList.add(keyboardFocusedClassName);
-      }
-
-      if (e.type === 'mousedown') {
-        document.body.classList.remove(keyboardFocusedClassName);
-      }
-    }
-
-    document.addEventListener('keydown', handleOutlineStyles);
-    document.addEventListener('mousedown', handleOutlineStyles);
-    return () => {
-      document.body.classList.remove(keyboardFocusedClassName);
-      document.removeEventListener('keydown', handleOutlineStyles);
-      document.removeEventListener('mousedown', handleOutlineStyles);
-    };
-  }, []);
-}
-
-export default useKeyboardNavigation;

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

@@ -1,20 +0,0 @@
-/**
- * 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.
- */
-import {useState, useEffect} from 'react';
-
-function useLocationHash(initialHash) {
-  const [hash, setHash] = useState(initialHash);
-  useEffect(() => {
-    const handleHashChange = () => setHash(window.location.hash);
-
-    window.addEventListener('hashchange', handleHashChange);
-    return () => window.removeEventListener('hashchange', handleHashChange);
-  }, []);
-  return [hash, setHash];
-}
-
-export default useLocationHash;

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

@@ -1,18 +0,0 @@
-/**
- * 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.
- */
-import {useEffect} from 'react';
-
-function useLockBodyScroll(lock = true) {
-  useEffect(() => {
-    document.body.style.overflow = lock ? 'hidden' : 'visible';
-    return () => {
-      document.body.style.overflow = 'visible';
-    };
-  }, [lock]);
-}
-
-export default useLockBodyScroll;

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

@@ -1,20 +0,0 @@
-/**
- * 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.
- */
-import defaultTheme from 'prism-react-renderer/themes/palenight';
-import useThemeContext from '@theme/hooks/useThemeContext';
-import {useThemeConfig} from '@docusaurus/theme-common';
-
-const usePrismTheme = () => {
-  const {prism} = useThemeConfig();
-  const {isDarkTheme} = useThemeContext();
-  const lightModeTheme = prism.theme || defaultTheme;
-  const darkModeTheme = prism.darkTheme || lightModeTheme;
-  const prismTheme = isDarkTheme ? darkModeTheme : lightModeTheme;
-  return prismTheme;
-};
-
-export default usePrismTheme;

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

@@ -1,42 +0,0 @@
-/**
- * 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.
- */
-import {useEffect, useRef} from 'react';
-import ExecutionEnvironment from '@docusaurus/ExecutionEnvironment';
-
-const getScrollPosition = () => {
-  return ExecutionEnvironment.canUseDOM
-    ? {
-        scrollX: window.pageXOffset,
-        scrollY: window.pageYOffset,
-      }
-    : null;
-};
-
-const useScrollPosition = (effect, deps = []) => {
-  const lastPositionRef = useRef(getScrollPosition());
-
-  const handleScroll = () => {
-    const currentPosition = getScrollPosition();
-
-    if (effect) {
-      effect(currentPosition, lastPositionRef.current);
-    }
-
-    lastPositionRef.current = currentPosition;
-  };
-
-  useEffect(() => {
-    const opts = {
-      passive: true,
-    };
-    handleScroll();
-    window.addEventListener('scroll', handleScroll, opts);
-    return () => window.removeEventListener('scroll', handleScroll, opts);
-  }, deps);
-};
-
-export default useScrollPosition;

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

@@ -1,84 +0,0 @@
-/**
- * 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.
- */
-import {useEffect, useState} from 'react';
-
-function useTOCHighlight(linkClassName, linkActiveClassName, topOffset) {
-  const [lastActiveLink, setLastActiveLink] = useState(undefined);
-  useEffect(() => {
-    function setActiveLink() {
-      function getActiveHeaderAnchor() {
-        const headersAnchors = Array.from(
-          document.getElementsByClassName('anchor'),
-        );
-        const firstAnchorUnderViewportTop = headersAnchors.find((anchor) => {
-          const {top} = anchor.getBoundingClientRect();
-          return top >= topOffset;
-        });
-
-        if (firstAnchorUnderViewportTop) {
-          // If first anchor in viewport is under a certain threshold, we consider it's not the active anchor.
-          // In such case, the active anchor is the previous one (if it exists), that may be above the viewport
-          if (
-            firstAnchorUnderViewportTop.getBoundingClientRect().top >= topOffset
-          ) {
-            const previousAnchor =
-              headersAnchors[
-                headersAnchors.indexOf(firstAnchorUnderViewportTop) - 1
-              ];
-            return previousAnchor ?? firstAnchorUnderViewportTop;
-          } // If the anchor is at the top of the viewport, we consider it's the first anchor
-          else {
-            return firstAnchorUnderViewportTop;
-          }
-        } // no anchor under viewport top? (ie we are at the bottom of the page)
-        else {
-          // highlight the last anchor found
-          return headersAnchors[headersAnchors.length - 1];
-        }
-      }
-
-      const activeHeaderAnchor = getActiveHeaderAnchor();
-
-      if (activeHeaderAnchor) {
-        let index = 0;
-        let itemHighlighted = false; // @ts-expect-error: Must be <a> tags.
-
-        const links = document.getElementsByClassName(linkClassName);
-
-        while (index < links.length && !itemHighlighted) {
-          const link = links[index];
-          const {href} = link;
-          const anchorValue = decodeURIComponent(
-            href.substring(href.indexOf('#') + 1),
-          );
-
-          if (activeHeaderAnchor.id === anchorValue) {
-            if (lastActiveLink) {
-              lastActiveLink.classList.remove(linkActiveClassName);
-            }
-
-            link.classList.add(linkActiveClassName);
-            setLastActiveLink(link);
-            itemHighlighted = true;
-          }
-
-          index += 1;
-        }
-      }
-    }
-
-    document.addEventListener('scroll', setActiveLink);
-    document.addEventListener('resize', setActiveLink);
-    setActiveLink();
-    return () => {
-      document.removeEventListener('scroll', setActiveLink);
-      document.removeEventListener('resize', setActiveLink);
-    };
-  });
-}
-
-export default useTOCHighlight;

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

@@ -1,39 +0,0 @@
-/**
- * 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.
- */
-import {useState, useCallback, useEffect} from 'react';
-import {createStorageSlot, listStorageKeys} from '@docusaurus/theme-common';
-const TAB_CHOICE_PREFIX = 'docusaurus.tab.';
-
-const useTabGroupChoice = () => {
-  const [tabGroupChoices, setChoices] = useState({});
-  const setChoiceSyncWithLocalStorage = useCallback((groupId, newChoice) => {
-    createStorageSlot(`${TAB_CHOICE_PREFIX}${groupId}`).set(newChoice);
-  }, []);
-  useEffect(() => {
-    try {
-      const localStorageChoices = {};
-      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);
-    }
-  }, []);
-  return {
-    tabGroupChoices,
-    setTabGroupChoices: (groupId, newChoice) => {
-      setChoices((oldChoices) => ({...oldChoices, [groupId]: newChoice}));
-      setChoiceSyncWithLocalStorage(groupId, newChoice);
-    },
-  };
-};
-
-export default useTabGroupChoice;