@docusaurus/theme-classic 2.0.0-beta.ff31de0ff → 2.0.1

package/src/theme/LayoutProviders/index.tsx

@@ -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 ThemeProvider from '@theme/ThemeProvider';
-import UserPreferencesProvider from '@theme/UserPreferencesProvider';
-import {DocsPreferredVersionContextProvider} from '@docusaurus/theme-common';
-import type {Props} from '@theme/LayoutProviders';
-
-export default function LayoutProviders({children}: Props): JSX.Element {
-  return (
-    <ThemeProvider>
-      <UserPreferencesProvider>
-        <DocsPreferredVersionContextProvider>
-          {children}
-        </DocsPreferredVersionContextProvider>
-      </UserPreferencesProvider>
-    </ThemeProvider>
-  );
-}

package/src/theme/NavbarItem/LocaleDropdownNavbarItem.tsx

@@ -1,67 +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 DefaultNavbarItem from '@theme/NavbarItem/DefaultNavbarItem';
-import IconLanguage from '@theme/IconLanguage';
-import type {Props} from '@theme/NavbarItem/LocaleDropdownNavbarItem';
-import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
-import {useAlternatePageUtils} from '@docusaurus/theme-common';
-
-export default function LocaleDropdownNavbarItem({
-  mobile,
-  dropdownItemsBefore,
-  dropdownItemsAfter,
-  ...props
-}: Props): JSX.Element {
-  const {
-    i18n: {currentLocale, locales, localeConfigs},
-  } = useDocusaurusContext();
-  const alternatePageUtils = useAlternatePageUtils();
-
-  function getLocaleLabel(locale) {
-    return localeConfigs[locale].label;
-  }
-
-  const localeItems = locales.map((locale) => {
-    const to = `pathname://${alternatePageUtils.createUrl({
-      locale,
-      fullyQualified: false,
-    })}`;
-    return {
-      isNavLink: true,
-      label: getLocaleLabel(locale),
-      to,
-      target: '_self',
-      autoAddBaseUrl: false,
-      className: locale === currentLocale ? 'dropdown__link--active' : '',
-      style: {textTransform: 'capitalize'},
-    };
-  });
-
-  const items = [...dropdownItemsBefore, ...localeItems, ...dropdownItemsAfter];
-
-  // Mobile is handled a bit differently
-  const dropdownLabel = mobile ? 'Languages' : getLocaleLabel(currentLocale);
-
-  return (
-    <DefaultNavbarItem
-      {...props}
-      href="#"
-      mobile={mobile}
-      label={
-        <span>
-          <IconLanguage
-            style={{verticalAlign: 'text-bottom', marginRight: 5}}
-          />
-          <span>{dropdownLabel}</span>
-        </span>
-      }
-      items={items}
-    />
-  );
-}

package/src/theme/SearchMetadatas/index.tsx

@@ -1,28 +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 Head from '@docusaurus/Head';
-import type {Props} from '@theme/SearchMetadatas';
-
-// Note: we don't couple this to Algolia/DocSearch on purpose
-// We may want to support other search engine plugins too
-// Search plugins should swizzle/override this comp to add their behavior
-export default function SearchMetadatas({
-  locale,
-  version,
-  tag,
-}: Props): JSX.Element {
-  return (
-    <Head>
-      {locale && <meta name="docusaurus_locale" content={`${locale}`} />}
-      {version && <meta name="docusaurus_version" content={version} />}
-      {tag && <meta name="docusaurus_tag" content={tag} />}
-    </Head>
-  );
-}

package/src/theme/Seo/index.tsx

@@ -1,47 +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 Head from '@docusaurus/Head';
-import {useThemeConfig, useTitleFormatter} from '@docusaurus/theme-common';
-import useBaseUrl from '@docusaurus/useBaseUrl';
-
-import type {Props} from '@theme/Seo';
-
-export default function Seo({
-  title,
-  description,
-  keywords,
-  image,
-}: Props): JSX.Element {
-  const {image: defaultImage} = useThemeConfig();
-  const pageTitle = useTitleFormatter(title);
-  const pageImage = useBaseUrl(image || defaultImage, {absolute: true});
-
-  return (
-    <Head>
-      {title && <title>{pageTitle}</title>}
-      {title && <meta property="og:title" content={pageTitle} />}
-
-      {description && <meta name="description" content={description} />}
-      {description && <meta property="og:description" content={description} />}
-
-      {keywords && (
-        <meta
-          name="keywords"
-          content={
-            (Array.isArray(keywords) ? keywords.join(',') : keywords) as string
-          }
-        />
-      )}
-
-      {pageImage && <meta property="og:image" content={pageImage} />}
-      {pageImage && <meta name="twitter:image" content={pageImage} />}
-      {pageImage && <meta name="twitter:card" content="summary_large_image" />}
-    </Head>
-  );
-}

package/src/theme/ThemeProvider/index.tsx

@@ -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 useTheme from '@theme/hooks/useTheme';
-import ThemeContext from '@theme/ThemeContext';
-import type {Props} from '@theme/ThemeProvider';
-
-function ThemeProvider(props: Props): JSX.Element {
-  const {isDarkTheme, setLightTheme, setDarkTheme} = useTheme();
-
-  return (
-    <ThemeContext.Provider value={{isDarkTheme, setLightTheme, setDarkTheme}}>
-      {props.children}
-    </ThemeContext.Provider>
-  );
-}
-
-export default ThemeProvider;

package/src/theme/Toggle/index.tsx

@@ -1,113 +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, CSSProperties} from 'react';
-import type {Props} from '@theme/Toggle';
-import {useThemeConfig} from '@docusaurus/theme-common';
-import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
-
-import clsx from 'clsx';
-import styles from './styles.module.css';
-
-interface IconProps {
-  icon: string;
-  style: CSSProperties;
-}
-
-const Dark = ({icon, style}: IconProps): JSX.Element => (
-  <span className={clsx(styles.toggle, styles.dark)} style={style}>
-    {icon}
-  </span>
-);
-const Light = ({icon, style}: IconProps): JSX.Element => (
-  <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,
-  }: Props & {
-    icons: {checked: JSX.Element; unchecked: JSX.Element};
-    disabled: boolean;
-  }): JSX.Element => {
-    const [checked, setChecked] = useState(defaultChecked);
-    const [focused, setFocused] = useState(false);
-    const inputRef = useRef<HTMLInputElement>(null);
-    const handleToggle = (e) => {
-      const checkbox = inputRef.current;
-
-      if (!checkbox) {
-        return;
-      }
-
-      if (e.target !== checkbox) {
-        e.preventDefault();
-        checkbox.focus();
-        checkbox.click();
-        return;
-      }
-
-      setChecked(checkbox?.checked);
-    };
-
-    return (
-      <div
-        className={clsx('react-toggle', className, {
-          'react-toggle--checked': checked,
-          'react-toggle--focus': focused,
-          'react-toggle--disabled': disabled,
-        })}
-        role="button"
-        tabIndex={-1}
-        onClick={handleToggle}>
-        <div className="react-toggle-track">
-          <div className="react-toggle-track-check">{icons.checked}</div>
-          <div className="react-toggle-track-x">{icons.unchecked}</div>
-        </div>
-        <div className="react-toggle-thumb" />
-
-        <input
-          ref={inputRef}
-          checked={checked}
-          type="checkbox"
-          className="react-toggle-screenreader-only"
-          aria-label="Switch between dark and light mode"
-          onChange={onChange}
-          onFocus={() => setFocused(true)}
-          onBlur={() => setFocused(false)}
-        />
-      </div>
-    );
-  },
-);
-
-export default function (props: Props): JSX.Element {
-  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/src/theme/Toggle/styles.module.css

@@ -1,114 +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.
- */
-
-.toggle {
-  align-items: center;
-  display: flex;
-  height: 10px;
-  justify-content: center;
-  width: 10px;
-}
-.toggle::before {
-  position: absolute;
-}
-
-/**
- * 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
- */
-:global(.react-toggle) {
-  touch-action: pan-x;
-  position: relative;
-  cursor: pointer;
-  user-select: none;
-  -webkit-tap-highlight-color: transparent;
-}
-
-:global(.react-toggle-screenreader-only) {
-  border: 0;
-  clip: rect(0 0 0 0);
-  height: 1px;
-  margin: -1px;
-  overflow: hidden;
-  position: absolute;
-  width: 1px;
-}
-
-:global(.react-toggle--disabled) {
-  cursor: not-allowed;
-}
-
-:global(.react-toggle-track) {
-  width: 50px;
-  height: 24px;
-  border-radius: 30px;
-  background-color: #4d4d4d;
-  transition: all 0.2s ease;
-}
-
-:global(.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;
-}
-
-:global([data-theme='dark'] .react-toggle .react-toggle-track-check),
-:global(.react-toggle--checked .react-toggle-track-check) {
-  opacity: 1;
-  transition: opacity 0.25s ease;
-}
-
-:global(.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;
-}
-
-:global([data-theme='dark'] .react-toggle .react-toggle-track-x),
-:global(.react-toggle--checked .react-toggle-track-x) {
-  opacity: 0;
-}
-
-:global(.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;
-}
-
-:global([data-theme='dark'] .react-toggle .react-toggle-thumb),
-:global(.react-toggle--checked .react-toggle-thumb) {
-  left: 27px;
-}
-
-:global(.react-toggle--focus .react-toggle-thumb),
-:global(.react-toggle:hover .react-toggle-thumb) {
-  box-shadow: 0px 0px 2px 3px var(--ifm-color-primary);
-}
-
-:global(.react-toggle:active:not(.react-toggle--disabled) .react-toggle-thumb) {
-  box-shadow: 0px 0px 5px 5px var(--ifm-color-primary);
-}

package/src/theme/UserPreferencesContext.ts

@@ -1,12 +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/src/theme/UserPreferencesProvider/index.tsx

@@ -1,32 +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 useAnnouncementBar from '@theme/hooks/useAnnouncementBar';
-import UserPreferencesContext from '@theme/UserPreferencesContext';
-import type {Props} from '@theme/UserPreferencesProvider';
-
-function UserPreferencesProvider(props: Props): JSX.Element {
-  const {tabGroupChoices, setTabGroupChoices} = useTabGroupChoice();
-  const {isAnnouncementBarClosed, closeAnnouncementBar} = useAnnouncementBar();
-
-  return (
-    <UserPreferencesContext.Provider
-      value={{
-        tabGroupChoices,
-        setTabGroupChoices,
-        isAnnouncementBarClosed,
-        closeAnnouncementBar,
-      }}>
-      {props.children}
-    </UserPreferencesContext.Provider>
-  );
-}
-
-export default UserPreferencesProvider;

package/src/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/src/theme/hooks/useAnnouncementBar.ts

@@ -1,58 +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, useCallback} from 'react';
-import {useThemeConfig, createStorageSlot} from '@docusaurus/theme-common';
-import type {useAnnouncementBarReturns} from '@theme/hooks/useAnnouncementBar';
-
-const DismissStorage = createStorageSlot('docusaurus.announcement.dismiss');
-const IdStorage = createStorageSlot('docusaurus.announcement.id');
-
-const useAnnouncementBar = (): useAnnouncementBarReturns => {
-  const {announcementBar} = useThemeConfig();
-
-  const [isClosed, setClosed] = useState(true);
-
-  const handleClose = useCallback(() => {
-    DismissStorage.set('true');
-    setClosed(true);
-  }, []);
-
-  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,
-  };
-};
-
-export default useAnnouncementBar;

package/src/theme/hooks/useContextualSearchFilters.ts

@@ -1,52 +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';
-
-type ContextualSearchFilters = {
-  locale: string;
-  tags: string[];
-};
-
-// 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(): ContextualSearchFilters {
-  const {i18n} = useDocusaurusContext();
-  const allDocsData = useAllDocsData();
-  const activePluginAndVersion = useActivePluginAndVersion();
-  const docsPreferredVersionByPluginId = useDocsPreferredVersionByPluginId();
-
-  function getDocPluginTags(pluginId: string) {
-    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/src/theme/hooks/useDocs.ts

@@ -1,11 +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/src/theme/hooks/useHideableNavbar.ts

@@ -1,85 +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 {useChangeRoute} from '@docusaurus/theme-common';
-import type {useHideableNavbarReturns} from '@theme/hooks/useHideableNavbar';
-
-const useHideableNavbar = (hideOnScroll: boolean): useHideableNavbarReturns => {
-  const location = useLocation();
-  const [isNavbarVisible, setIsNavbarVisible] = useState(hideOnScroll);
-  const isFocusedAnchor = useRef(false);
-  const [navbarHeight, setNavbarHeight] = useState(0);
-  const navbarRef = useCallback((node: HTMLElement | null) => {
-    if (node !== null) {
-      setNavbarHeight(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;
-      }
-
-      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],
-  );
-
-  useChangeRoute(() => {
-    if (!hideOnScroll) {
-      return;
-    }
-
-    setIsNavbarVisible(true);
-  });
-
-  useEffect(() => {
-    if (!hideOnScroll) {
-      return;
-    }
-
-    if (!location.hash) {
-      return;
-    }
-
-    isFocusedAnchor.current = true;
-  }, [location.hash]);
-
-  return {
-    navbarRef,
-    isNavbarVisible,
-  };
-};
-
-export default useHideableNavbar;