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

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;

package/lib/theme/hooks/useUserPreferencesContext.js

@@ -1,31 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _react = require("react");
-
-var _UserPreferencesContext = _interopRequireDefault(require("@theme/UserPreferencesContext"));
-
-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 useUserPreferencesContext() {
-  const context = (0, _react.useContext)(_UserPreferencesContext.default);
-
-  if (context == null) {
-    throw new Error('"useUserPreferencesContext" is used outside of "Layout" component.');
-  }
-
-  return context;
-}
-
-var _default = useUserPreferencesContext;
-exports.default = _default;

package/lib/theme/hooks/useWindowSize.js

@@ -1,73 +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 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 getWindowSize() {
-  if (!_ExecutionEnvironment.default.canUseDOM) {
-    return windowSizes.ssr;
-  }
-
-  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!
-
-
-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
-
-function useWindowSize() {
-  const [windowSize, setWindowSize] = (0, _react.useState)(() => {
-    if (DevSimulateSSR) {
-      return 'ssr';
-    }
-
-    return getWindowSize();
-  });
-  (0, _react.useEffect)(() => {
-    if (!_ExecutionEnvironment.default.canUseDOM) {
-      return undefined;
-    }
-
-    function updateWindowSize() {
-      setWindowSize(getWindowSize());
-    } // @ts-expect-error: annoying TS setTimeout typing...
-
-
-    const timeout = DevSimulateSSR ? setTimeout(updateWindowSize, 1000) : undefined;
-    window.addEventListener('resize', updateWindowSize);
-    return () => {
-      window.removeEventListener('resize', updateWindowSize);
-      clearTimeout(timeout);
-    };
-  }, []);
-  return windowSize;
-}
-
-var _default = useWindowSize;
-exports.default = _default;

package/lib/theme/prism-include-languages.js

@@ -1,39 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _ExecutionEnvironment = _interopRequireDefault(require("@docusaurus/ExecutionEnvironment"));
-
-var _docusaurus = _interopRequireDefault(require("@generated/docusaurus.config"));
-
-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 prismIncludeLanguages = PrismObject => {
-  if (_ExecutionEnvironment.default.canUseDOM) {
-    const {
-      themeConfig: {
-        prism: {
-          additionalLanguages = []
-        } = {}
-      }
-    } = _docusaurus.default;
-    window.Prism = PrismObject;
-    additionalLanguages.forEach(lang => {
-      require(`prismjs/components/prism-${lang}`); // eslint-disable-line
-
-    });
-    delete window.Prism;
-  }
-};
-
-var _default = prismIncludeLanguages;
-exports.default = _default;

package/lib-next/__tests__/__snapshots__/translations.test.ts.snap

@@ -1,116 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`getTranslationFiles should return translation files matching snapshot 1`] = `
-Array [
-  Object {
-    "content": Object {
-      "item.label.Dropdown": Object {
-        "description": "Navbar item with label Dropdown",
-        "message": "Dropdown",
-      },
-      "item.label.Dropdown item 1": Object {
-        "description": "Navbar item with label Dropdown item 1",
-        "message": "Dropdown item 1",
-      },
-      "item.label.Dropdown item 2": Object {
-        "description": "Navbar item with label Dropdown item 2",
-        "message": "Dropdown item 2",
-      },
-      "title": Object {
-        "description": "The title in the navbar",
-        "message": "navbar title",
-      },
-    },
-    "path": "navbar",
-  },
-  Object {
-    "content": Object {
-      "copyright": Object {
-        "description": "The footer copyright",
-        "message": "Copyright FB",
-      },
-      "link.item.label.Link 1": Object {
-        "description": "The label of footer link with label=Link 1 linking to https://facebook.com",
-        "message": "Link 1",
-      },
-      "link.item.label.Link 2": Object {
-        "description": "The label of footer link with label=Link 2 linking to https://facebook.com",
-        "message": "Link 2",
-      },
-      "link.item.label.Link 3": Object {
-        "description": "The label of footer link with label=Link 3 linking to https://facebook.com",
-        "message": "Link 3",
-      },
-      "link.title.Footer link column 1": Object {
-        "description": "The title of the footer links column with title=Footer link column 1 in the footer",
-        "message": "Footer link column 1",
-      },
-      "link.title.Footer link column 2": Object {
-        "description": "The title of the footer links column with title=Footer link column 2 in the footer",
-        "message": "Footer link column 2",
-      },
-    },
-    "path": "footer",
-  },
-]
-`;
-
-exports[`translateThemeConfig should return translated themeConfig matching snapshot 1`] = `
-Object {
-  "announcementBar": Object {},
-  "colorMode": Object {},
-  "docs": Object {
-    "versionPersistence": "none",
-  },
-  "footer": Object {
-    "copyright": "Copyright FB (translated)",
-    "links": Array [
-      Object {
-        "items": Array [
-          Object {
-            "label": "Link 1 (translated)",
-            "to": "https://facebook.com",
-          },
-          Object {
-            "label": "Link 2 (translated)",
-            "to": "https://facebook.com",
-          },
-        ],
-        "title": "Footer link column 1 (translated)",
-      },
-      Object {
-        "items": Array [
-          Object {
-            "label": "Link 3 (translated)",
-            "to": "https://facebook.com",
-          },
-        ],
-        "title": "Footer link column 2 (translated)",
-      },
-    ],
-    "style": "light",
-  },
-  "hideableSidebar": true,
-  "navbar": Object {
-    "hideOnScroll": false,
-    "items": Array [
-      Object {
-        "items": Array [
-          Object {
-            "items": Array [],
-            "label": "Dropdown item 1 (translated)",
-          },
-          Object {
-            "items": Array [],
-            "label": "Dropdown item 2 (translated)",
-          },
-        ],
-        "label": "Dropdown (translated)",
-      },
-    ],
-    "style": "dark",
-    "title": "navbar title (translated)",
-  },
-  "prism": Object {},
-}
-`;

package/lib-next/__tests__/translations.test.js

@@ -1,128 +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 {getTranslationFiles, translateThemeConfig} from '../translations';
-import {updateTranslationFileMessages} from '@docusaurus/utils';
-const ThemeConfigSample = {
-  colorMode: {},
-  announcementBar: {},
-  prism: {},
-  docs: {
-    versionPersistence: 'none',
-  },
-  hideableSidebar: true,
-  navbar: {
-    title: 'navbar title',
-    style: 'dark',
-    hideOnScroll: false,
-    items: [
-      {
-        label: 'Dropdown',
-        items: [
-          {
-            label: 'Dropdown item 1',
-            items: [],
-          },
-          {
-            label: 'Dropdown item 2',
-            items: [],
-          },
-        ],
-      },
-    ],
-  },
-  footer: {
-    copyright: 'Copyright FB',
-    style: 'light',
-    links: [
-      {
-        title: 'Footer link column 1',
-        items: [
-          {
-            label: 'Link 1',
-            to: 'https://facebook.com',
-          },
-          {
-            label: 'Link 2',
-            to: 'https://facebook.com',
-          },
-        ],
-      },
-      {
-        title: 'Footer link column 2',
-        items: [
-          {
-            label: 'Link 3',
-            to: 'https://facebook.com',
-          },
-        ],
-      },
-    ],
-  },
-};
-
-function getSampleTranslationFiles() {
-  return getTranslationFiles({
-    themeConfig: ThemeConfigSample,
-  });
-}
-
-function getSampleTranslationFilesTranslated() {
-  const translationFiles = getSampleTranslationFiles();
-  return translationFiles.map((translationFile) =>
-    updateTranslationFileMessages(
-      translationFile,
-      (message) => `${message} (translated)`,
-    ),
-  );
-}
-
-describe('getTranslationFiles', () => {
-  test('should return translation files matching snapshot', () => {
-    expect(getSampleTranslationFiles()).toMatchSnapshot();
-  });
-});
-describe('translateThemeConfig', () => {
-  test('should not translate anything if translation files are untranslated', () => {
-    const translationFiles = getSampleTranslationFiles();
-    expect(
-      translateThemeConfig({
-        themeConfig: ThemeConfigSample,
-        translationFiles,
-      }),
-    ).toEqual(ThemeConfigSample);
-  });
-  test('should return translated themeConfig matching snapshot', () => {
-    const translationFiles = getSampleTranslationFilesTranslated();
-    expect(
-      translateThemeConfig({
-        themeConfig: ThemeConfigSample,
-        translationFiles,
-      }),
-    ).toMatchSnapshot();
-  });
-});
-describe('getTranslationFiles and translateThemeConfig isomorphism', () => {
-  function verifyIsomorphism(themeConfig) {
-    const translationFiles = getTranslationFiles({
-      themeConfig,
-    });
-    const translatedThemeConfig = translateThemeConfig({
-      themeConfig,
-      translationFiles,
-    });
-    expect(translatedThemeConfig).toEqual(themeConfig);
-  }
-
-  test('should be verified for main sample', () => {
-    verifyIsomorphism(ThemeConfigSample);
-  }); // undefined footer should not make the translation code crash
-  // See https://github.com/facebook/docusaurus/issues/3936
-
-  test('should be verified for sample without footer', () => {
-    verifyIsomorphism({...ThemeConfigSample, footer: undefined});
-  });
-});