@docusaurus/theme-classic 2.0.0-beta.2 → 2.0.0-beta.22

package/lib/theme/hooks/styles.css

@@ -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.
- */
-
-body:not(.navigation-with-keyboard) *:not(input):focus {
-  outline: none;
-}

package/lib/theme/hooks/useAnnouncementBar.js

@@ -1,63 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _react = require("react");
-
-var _themeCommon = require("@docusaurus/theme-common");
-
-/**
- * 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.
- */
-const DismissStorage = (0, _themeCommon.createStorageSlot)('docusaurus.announcement.dismiss');
-const IdStorage = (0, _themeCommon.createStorageSlot)('docusaurus.announcement.id');
-
-const useAnnouncementBar = () => {
-  const {
-    announcementBar
-  } = (0, _themeCommon.useThemeConfig)();
-  const [isClosed, setClosed] = (0, _react.useState)(true);
-  const handleClose = (0, _react.useCallback)(() => {
-    DismissStorage.set('true');
-    setClosed(true);
-  }, []);
-  (0, _react.useEffect)(() => {
-    if (!announcementBar) {
-      return;
-    }
-
-    const {
-      id
-    } = announcementBar;
-    let viewedId = IdStorage.get(); // retrocompatibility due to spelling mistake of default id
-    // see https://github.com/facebook/docusaurus/issues/3338
-
-    if (viewedId === 'annoucement-bar') {
-      viewedId = 'announcement-bar';
-    }
-
-    const isNewAnnouncement = id !== viewedId;
-    IdStorage.set(id);
-
-    if (isNewAnnouncement) {
-      DismissStorage.set('false');
-    }
-
-    if (isNewAnnouncement || DismissStorage.get() === 'false') {
-      setClosed(false);
-    }
-  }, []);
-  return {
-    isAnnouncementBarClosed: isClosed,
-    closeAnnouncementBar: handleClose
-  };
-};
-
-var _default = useAnnouncementBar;
-exports.default = _default;

package/lib/theme/hooks/useContextualSearchFilters.js

@@ -1,47 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = useContextualSearchFilters;
-
-var _useDocs = require("@theme/hooks/useDocs");
-
-var _themeCommon = require("@docusaurus/theme-common");
-
-var _useDocusaurusContext = _interopRequireDefault(require("@docusaurus/useDocusaurusContext"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-/**
- * 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.
- */
-// 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
-function useContextualSearchFilters() {
-  const {
-    i18n
-  } = (0, _useDocusaurusContext.default)();
-  const allDocsData = (0, _useDocs.useAllDocsData)();
-  const activePluginAndVersion = (0, _useDocs.useActivePluginAndVersion)();
-  const docsPreferredVersionByPluginId = (0, _themeCommon.useDocsPreferredVersionByPluginId)();
-
-  function getDocPluginTags(pluginId) {
-    var _activePluginAndVersi, _ref;
-
-    const activeVersion = (activePluginAndVersion === null || activePluginAndVersion === void 0 ? void 0 : (_activePluginAndVersi = activePluginAndVersion.activePlugin) === null || _activePluginAndVersi === void 0 ? void 0 : _activePluginAndVersi.pluginId) === pluginId ? activePluginAndVersion.activeVersion : undefined;
-    const preferredVersion = docsPreferredVersionByPluginId[pluginId];
-    const latestVersion = allDocsData[pluginId].versions.find(v => v.isLast);
-    const version = (_ref = activeVersion !== null && activeVersion !== void 0 ? activeVersion : preferredVersion) !== null && _ref !== void 0 ? _ref : latestVersion;
-    return (0, _themeCommon.docVersionSearchTag)(pluginId, version.name);
-  }
-
-  const tags = [_themeCommon.DEFAULT_SEARCH_TAG, ...Object.keys(allDocsData).map(getDocPluginTags)];
-  return {
-    locale: i18n.currentLocale,
-    tags
-  };
-}

package/lib/theme/hooks/useDocs.js

@@ -1,18 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-
-var _useDocs = require("@docusaurus/plugin-content-docs/lib/theme/hooks/useDocs");
-
-Object.keys(_useDocs).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _useDocs[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function () {
-      return _useDocs[key];
-    }
-  });
-});

package/lib/theme/hooks/useHideableNavbar.js

@@ -1,92 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _react = require("react");
-
-var _router = require("@docusaurus/router");
-
-var _useScrollPosition = _interopRequireDefault(require("@theme/hooks/useScrollPosition"));
-
-var _themeCommon = require("@docusaurus/theme-common");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-/**
- * 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.
- */
-const useHideableNavbar = hideOnScroll => {
-  const location = (0, _router.useLocation)();
-  const [isNavbarVisible, setIsNavbarVisible] = (0, _react.useState)(hideOnScroll);
-  const isFocusedAnchor = (0, _react.useRef)(false);
-  const [navbarHeight, setNavbarHeight] = (0, _react.useState)(0);
-  const navbarRef = (0, _react.useCallback)(node => {
-    if (node !== null) {
-      setNavbarHeight(node.getBoundingClientRect().height);
-    }
-  }, []);
-  (0, _useScrollPosition.default)(({
-    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);
-    }
-
-    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]);
-  (0, _themeCommon.useLocationChange)(locationChangeEvent => {
-    if (!hideOnScroll || locationChangeEvent.location.hash) {
-      return;
-    }
-
-    setIsNavbarVisible(true);
-  });
-  (0, _react.useEffect)(() => {
-    if (!hideOnScroll) {
-      return;
-    }
-
-    if (!location.hash) {
-      return;
-    }
-
-    isFocusedAnchor.current = true;
-  }, [location.hash]);
-  return {
-    navbarRef,
-    isNavbarVisible
-  };
-};
-
-var _default = useHideableNavbar;
-exports.default = _default;

package/lib/theme/hooks/useKeyboardNavigation.js

@@ -1,45 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _react = require("react");
-
-require("./styles.css");
-
-/**
- * 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.
- */
-// 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() {
-  (0, _react.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);
-    };
-  }, []);
-}
-
-var _default = useKeyboardNavigation;
-exports.default = _default;

package/lib/theme/hooks/useLocationHash.js

@@ -1,28 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _react = require("react");
-
-/**
- * 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.
- */
-function useLocationHash(initialHash) {
-  const [hash, setHash] = (0, _react.useState)(initialHash);
-  (0, _react.useEffect)(() => {
-    const handleHashChange = () => setHash(window.location.hash);
-
-    window.addEventListener('hashchange', handleHashChange);
-    return () => window.removeEventListener('hashchange', handleHashChange);
-  }, []);
-  return [hash, setHash];
-}
-
-var _default = useLocationHash;
-exports.default = _default;

package/lib/theme/hooks/useLockBodyScroll.js

@@ -1,26 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _react = require("react");
-
-/**
- * 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.
- */
-function useLockBodyScroll(lock = true) {
-  (0, _react.useEffect)(() => {
-    document.body.style.overflow = lock ? 'hidden' : 'visible';
-    return () => {
-      document.body.style.overflow = 'visible';
-    };
-  }, [lock]);
-}
-
-var _default = useLockBodyScroll;
-exports.default = _default;

package/lib/theme/hooks/usePrismTheme.js

@@ -1,36 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _palenight = _interopRequireDefault(require("prism-react-renderer/themes/palenight"));
-
-var _useThemeContext = _interopRequireDefault(require("@theme/hooks/useThemeContext"));
-
-var _themeCommon = require("@docusaurus/theme-common");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-/**
- * 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.
- */
-const usePrismTheme = () => {
-  const {
-    prism
-  } = (0, _themeCommon.useThemeConfig)();
-  const {
-    isDarkTheme
-  } = (0, _useThemeContext.default)();
-  const lightModeTheme = prism.theme || _palenight.default;
-  const darkModeTheme = prism.darkTheme || lightModeTheme;
-  const prismTheme = isDarkTheme ? darkModeTheme : lightModeTheme;
-  return prismTheme;
-};
-
-var _default = usePrismTheme;
-exports.default = _default;

package/lib/theme/hooks/useScrollPosition.js

@@ -1,49 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _react = require("react");
-
-var _ExecutionEnvironment = _interopRequireDefault(require("@docusaurus/ExecutionEnvironment"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-/**
- * 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.
- */
-const getScrollPosition = () => ({
-  scrollX: _ExecutionEnvironment.default.canUseDOM ? window.pageXOffset : 0,
-  scrollY: _ExecutionEnvironment.default.canUseDOM ? window.pageYOffset : 0
-});
-
-const useScrollPosition = (effect, deps = []) => {
-  const scrollPosition = (0, _react.useRef)(getScrollPosition());
-
-  const handleScroll = () => {
-    const currentScrollPosition = getScrollPosition();
-
-    if (effect) {
-      effect(currentScrollPosition, scrollPosition.current);
-    }
-
-    scrollPosition.current = currentScrollPosition;
-  };
-
-  (0, _react.useEffect)(() => {
-    const opts = {
-      passive: true
-    };
-    handleScroll();
-    window.addEventListener('scroll', handleScroll, opts);
-    return () => window.removeEventListener('scroll', handleScroll, opts);
-  }, deps);
-};
-
-var _default = useScrollPosition;
-exports.default = _default;

package/lib/theme/hooks/useTOCHighlight.js

@@ -1,87 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _react = require("react");
-
-/**
- * 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.
- */
-function useTOCHighlight(linkClassName, linkActiveClassName, topOffset) {
-  const [lastActiveLink, setLastActiveLink] = (0, _react.useState)(undefined);
-  (0, _react.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 !== null && previousAnchor !== void 0 ? 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);
-    };
-  });
-}
-
-var _default = useTOCHighlight;
-exports.default = _default;

package/lib/theme/hooks/useTabGroupChoice.js

@@ -1,51 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _react = require("react");
-
-var _themeCommon = require("@docusaurus/theme-common");
-
-/**
- * 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.
- */
-const TAB_CHOICE_PREFIX = 'docusaurus.tab.';
-
-const useTabGroupChoice = () => {
-  const [tabGroupChoices, setChoices] = (0, _react.useState)({});
-  const setChoiceSyncWithLocalStorage = (0, _react.useCallback)((groupId, newChoice) => {
-    (0, _themeCommon.createStorageSlot)(`${TAB_CHOICE_PREFIX}${groupId}`).set(newChoice);
-  }, []);
-  (0, _react.useEffect)(() => {
-    try {
-      const localStorageChoices = {};
-      (0, _themeCommon.listStorageKeys)().forEach(storageKey => {
-        if (storageKey.startsWith(TAB_CHOICE_PREFIX)) {
-          const groupId = storageKey.substring(TAB_CHOICE_PREFIX.length);
-          localStorageChoices[groupId] = (0, _themeCommon.createStorageSlot)(storageKey).get();
-        }
-      });
-      setChoices(localStorageChoices);
-    } catch (err) {
-      console.error(err);
-    }
-  }, []);
-  return {
-    tabGroupChoices,
-    setTabGroupChoices: (groupId, newChoice) => {
-      setChoices(oldChoices => ({ ...oldChoices,
-        [groupId]: newChoice
-      }));
-      setChoiceSyncWithLocalStorage(groupId, newChoice);
-    }
-  };
-};
-
-var _default = useTabGroupChoice;
-exports.default = _default;

package/lib/theme/hooks/useTheme.js

@@ -1,99 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _react = require("react");
-
-var _ExecutionEnvironment = _interopRequireDefault(require("@docusaurus/ExecutionEnvironment"));
-
-var _themeCommon = require("@docusaurus/theme-common");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-/**
- * 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.
- */
-const ThemeStorage = (0, _themeCommon.createStorageSlot)('theme');
-const themes = {
-  light: 'light',
-  dark: 'dark'
-};
-
-// Ensure to always return a valid theme even if input is invalid
-const coerceToTheme = theme => {
-  return theme === themes.dark ? themes.dark : themes.light;
-};
-
-const getInitialTheme = defaultMode => {
-  if (!_ExecutionEnvironment.default.canUseDOM) {
-    return coerceToTheme(defaultMode);
-  }
-
-  return coerceToTheme(document.documentElement.getAttribute('data-theme'));
-};
-
-const storeTheme = newTheme => {
-  (0, _themeCommon.createStorageSlot)('theme').set(coerceToTheme(newTheme));
-};
-
-const useTheme = () => {
-  const {
-    colorMode: {
-      defaultMode,
-      disableSwitch,
-      respectPrefersColorScheme
-    }
-  } = (0, _themeCommon.useThemeConfig)();
-  const [theme, setTheme] = (0, _react.useState)(getInitialTheme(defaultMode));
-  const setLightTheme = (0, _react.useCallback)(() => {
-    setTheme(themes.light);
-    storeTheme(themes.light);
-  }, []);
-  const setDarkTheme = (0, _react.useCallback)(() => {
-    setTheme(themes.dark);
-    storeTheme(themes.dark);
-  }, []);
-  (0, _react.useEffect)(() => {
-    document.documentElement.setAttribute('data-theme', coerceToTheme(theme));
-  }, [theme]);
-  (0, _react.useEffect)(() => {
-    if (disableSwitch) {
-      return;
-    }
-
-    try {
-      const storedTheme = ThemeStorage.get();
-
-      if (storedTheme !== null) {
-        setTheme(coerceToTheme(storedTheme));
-      }
-    } catch (err) {
-      console.error(err);
-    }
-  }, [setTheme]);
-  (0, _react.useEffect)(() => {
-    if (disableSwitch && !respectPrefersColorScheme) {
-      return;
-    }
-
-    window.matchMedia('(prefers-color-scheme: dark)').addListener(({
-      matches
-    }) => {
-      setTheme(matches ? themes.dark : themes.light);
-    });
-  }, []);
-  return {
-    isDarkTheme: theme === themes.dark,
-    setLightTheme,
-    setDarkTheme
-  };
-};
-
-var _default = useTheme;
-exports.default = _default;

package/lib/theme/hooks/useThemeContext.js

@@ -1,31 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _react = require("react");
-
-var _ThemeContext = _interopRequireDefault(require("@theme/ThemeContext"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-/**
- * 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.
- */
-function useThemeContext() {
-  const context = (0, _react.useContext)(_ThemeContext.default);
-
-  if (context == null) {
-    throw new Error('"useThemeContext" is used outside of "Layout" component. Please see https://docusaurus.io/docs/api/themes/configuration#usethemecontext.');
-  }
-
-  return context;
-}
-
-var _default = useThemeContext;
-exports.default = _default;