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

package/lib-next/theme/hooks/useTheme.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} from 'react';
-import ExecutionEnvironment from '@docusaurus/ExecutionEnvironment';
-import {useThemeConfig, createStorageSlot} from '@docusaurus/theme-common';
-const ThemeStorage = 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.canUseDOM) {
-    return coerceToTheme(defaultMode);
-  }
-
-  return coerceToTheme(document.documentElement.getAttribute('data-theme'));
-};
-
-const storeTheme = (newTheme) => {
-  createStorageSlot('theme').set(coerceToTheme(newTheme));
-};
-
-const useTheme = () => {
-  const {
-    colorMode: {defaultMode, disableSwitch, respectPrefersColorScheme},
-  } = useThemeConfig();
-  const [theme, setTheme] = useState(getInitialTheme(defaultMode));
-  const setLightTheme = useCallback(() => {
-    setTheme(themes.light);
-    storeTheme(themes.light);
-  }, []);
-  const setDarkTheme = useCallback(() => {
-    setTheme(themes.dark);
-    storeTheme(themes.dark);
-  }, []);
-  useEffect(() => {
-    document.documentElement.setAttribute('data-theme', coerceToTheme(theme));
-  }, [theme]);
-  useEffect(() => {
-    if (disableSwitch) {
-      return;
-    }
-
-    try {
-      const storedTheme = ThemeStorage.get();
-
-      if (storedTheme !== null) {
-        setTheme(coerceToTheme(storedTheme));
-      }
-    } catch (err) {
-      console.error(err);
-    }
-  }, [setTheme]);
-  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,
-  };
-};
-
-export default useTheme;

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

@@ -1,22 +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 {useContext} from 'react';
-import ThemeContext from '@theme/ThemeContext';
-
-function useThemeContext() {
-  const context = useContext(ThemeContext);
-
-  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;
-}
-
-export default useThemeContext;

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

@@ -1,22 +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 {useContext} from 'react';
-import UserPreferencesContext from '@theme/UserPreferencesContext';
-
-function useUserPreferencesContext() {
-  const context = useContext(UserPreferencesContext);
-
-  if (context == null) {
-    throw new Error(
-      '"useUserPreferencesContext" is used outside of "Layout" component.',
-    );
-  }
-
-  return context;
-}
-
-export default useUserPreferencesContext;

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

@@ -1,63 +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';
-import ExecutionEnvironment from '@docusaurus/ExecutionEnvironment';
-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.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] = useState(() => {
-    if (DevSimulateSSR) {
-      return 'ssr';
-    }
-
-    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)
-      : undefined;
-    window.addEventListener('resize', updateWindowSize);
-    return () => {
-      window.removeEventListener('resize', updateWindowSize);
-      clearTimeout(timeout);
-    };
-  }, []);
-  return windowSize;
-}
-
-export default useWindowSize;

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

@@ -1,23 +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 ExecutionEnvironment from '@docusaurus/ExecutionEnvironment';
-import siteConfig from '@generated/docusaurus.config';
-
-const prismIncludeLanguages = (PrismObject) => {
-  if (ExecutionEnvironment.canUseDOM) {
-    const {
-      themeConfig: {prism: {additionalLanguages = []} = {}},
-    } = siteConfig;
-    window.Prism = PrismObject;
-    additionalLanguages.forEach((lang) => {
-      require(`prismjs/components/prism-${lang}`); // eslint-disable-line
-    });
-    delete window.Prism;
-  }
-};
-
-export default prismIncludeLanguages;

package/lib-next/translations.js

@@ -1,145 +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 {keyBy, chain, flatten} 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);
-      }),
-    );
-    return [...items, ...subItems];
-  }
-
-  const allNavbarItems = flattenNavbarItems(navbar.items);
-  const navbarItemsTranslations = chain(
-    allNavbarItems.filter((navbarItem) => !!navbarItem.label),
-  )
-    .keyBy((navbarItem) => `item.label.${navbarItem.label}`)
-    .mapValues((navbarItem) => ({
-      message: navbarItem.label,
-      description: `Navbar item with label ${navbarItem.label}`,
-    }))
-    .value();
-  const titleTranslations = navbar.title
-    ? {
-        title: {
-          message: navbar.title,
-          description: 'The title in the navbar',
-        },
-      }
-    : {};
-  return mergeTranslations([titleTranslations, navbarItemsTranslations]);
-}
-
-function translateNavbar(navbar, navbarTranslations) {
-  return {
-    ...navbar,
-    title: navbarTranslations.title?.message ?? navbar.title,
-    //  TODO handle properly all the navbar item types here!
-    items: navbar.items.map((item) => {
-      const subItems = item.items?.map((subItem) => ({
-        ...subItem,
-        label:
-          navbarTranslations[`item.label.${subItem.label}`]?.message ??
-          subItem.label,
-      }));
-      return {
-        ...item,
-        label:
-          navbarTranslations[`item.label.${item.label}`]?.message ?? item.label,
-        ...(subItems
-          ? {
-              items: subItems,
-            }
-          : undefined),
-      };
-    }),
-  };
-}
-
-function getFooterTranslationFile(footer) {
-  // TODO POC code
-  const footerLinkTitles = chain(footer.links.filter((link) => !!link.title))
-    .keyBy((link) => `link.title.${link.title}`)
-    .mapValues((link) => ({
-      message: link.title,
-      description: `The title of the footer links column with title=${link.title} in the footer`,
-    }))
-    .value();
-  const footerLinkLabels = chain(
-    flatten(footer.links.map((link) => link.items)).filter(
-      (link) => !!link.label,
-    ),
-  )
-    .keyBy((linkItem) => `link.item.label.${linkItem.label}`)
-    .mapValues((linkItem) => ({
-      message: linkItem.label,
-      description: `The label of footer link with label=${
-        linkItem.label
-      } linking to ${linkItem.to ?? linkItem.href}`,
-    }))
-    .value();
-  const copyright = footer.copyright
-    ? {
-        copyright: {
-          message: footer.copyright,
-          description: 'The footer copyright',
-        },
-      }
-    : {};
-  return mergeTranslations([footerLinkTitles, footerLinkLabels, copyright]);
-}
-
-function translateFooter(footer, footerTranslations) {
-  const links = footer.links.map((link) => ({
-    ...link,
-    title:
-      footerTranslations[`link.title.${link.title}`]?.message ?? link.title,
-    items: link.items.map((linkItem) => ({
-      ...linkItem,
-      label:
-        footerTranslations[`link.item.label.${linkItem.label}`]?.message ??
-        linkItem.label,
-    })),
-  }));
-  const copyright = footerTranslations.copyright?.message ?? footer.copyright;
-  return {...footer, links, copyright};
-}
-
-export function getTranslationFiles({themeConfig}) {
-  const translationFiles = [
-    {
-      path: 'navbar',
-      content: getNavbarTranslationFile(themeConfig.navbar),
-    },
-    themeConfig.footer
-      ? {
-          path: 'footer',
-          content: getFooterTranslationFile(themeConfig.footer),
-        }
-      : undefined,
-  ];
-  return translationFiles.filter(Boolean);
-}
-export function translateThemeConfig({themeConfig, translationFiles}) {
-  const translationFilesMap = keyBy(translationFiles, (f) => f.path);
-  return {
-    ...themeConfig,
-    navbar: translateNavbar(
-      themeConfig.navbar,
-      translationFilesMap.navbar.content,
-    ),
-    footer: themeConfig.footer
-      ? translateFooter(themeConfig.footer, translationFilesMap.footer.content)
-      : undefined,
-  };
-}