@docusaurus/theme-classic 2.0.0-beta.13 → 2.0.0-beta.15

package/src/theme/Tabs/__tests__/index.test.tsx

@@ -1,129 +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 renderer from 'react-test-renderer';
-import Tabs from '../index';
-import TabItem from '../../TabItem';
-import UserPreferencesProvider from '@theme/UserPreferencesProvider';
-import {ScrollControllerProvider} from '@docusaurus/theme-common';
-
-describe('Tabs', () => {
-  test('Should reject bad Tabs child', () => {
-    expect(() => {
-      renderer.create(
-        <Tabs>
-          <div>Naughty</div>
-          <TabItem value="good">Good</TabItem>
-        </Tabs>,
-      );
-    }).toThrowErrorMatchingInlineSnapshot(
-      `"Docusaurus error: Bad <Tabs> child <div>: all children of the <Tabs> component should be <TabItem>, and every <TabItem> should have a unique \\"value\\" prop."`,
-    );
-  });
-  test('Should reject bad Tabs defaultValue', () => {
-    expect(() => {
-      renderer.create(
-        <Tabs defaultValue="bad">
-          <TabItem value="v1">Tab 1</TabItem>
-          <TabItem value="v2">Tab 2</TabItem>
-        </Tabs>,
-      );
-    }).toThrowErrorMatchingInlineSnapshot(
-      `"Docusaurus error: The <Tabs> has a defaultValue \\"bad\\" but none of its children has the corresponding value. Available values are: v1, v2. If you intend to show no default tab, use defaultValue={null} instead."`,
-    );
-  });
-  test('Should reject duplicate values', () => {
-    expect(() => {
-      renderer.create(
-        <Tabs>
-          <TabItem value="v1">Tab 1</TabItem>
-          <TabItem value="v2">Tab 2</TabItem>
-          <TabItem value="v3">Tab 3</TabItem>
-          <TabItem value="v4">Tab 4</TabItem>
-          <TabItem value="v1">Tab 5</TabItem>
-          <TabItem value="v2">Tab 6</TabItem>
-        </Tabs>,
-      );
-    }).toThrowErrorMatchingInlineSnapshot(
-      `"Docusaurus error: Duplicate values \\"v1, v2\\" found in <Tabs>. Every value needs to be unique."`,
-    );
-  });
-  test('Should accept valid Tabs config', () => {
-    expect(() => {
-      renderer.create(
-        <ScrollControllerProvider>
-          <UserPreferencesProvider>
-            <Tabs>
-              <TabItem value="v1">Tab 1</TabItem>
-              <TabItem value="v2">Tab 2</TabItem>
-            </Tabs>
-            <Tabs>
-              <TabItem value="v1">Tab 1</TabItem>
-              <TabItem value="v2" default>
-                Tab 2
-              </TabItem>
-            </Tabs>
-            <Tabs defaultValue="v1">
-              <TabItem value="v1" label="V1">
-                Tab 1
-              </TabItem>
-              <TabItem value="v2" label="V2">
-                Tab 2
-              </TabItem>
-            </Tabs>
-            <Tabs
-              defaultValue="v1"
-              values={[
-                {value: 'v1', label: 'V1'},
-                {value: 'v2', label: 'V2'},
-              ]}>
-              <TabItem value="v1">Tab 1</TabItem>
-              <TabItem value="v2">Tab 2</TabItem>
-            </Tabs>
-            <Tabs
-              defaultValue={null}
-              values={[
-                {value: 'v1', label: 'V1'},
-                {value: 'v2', label: 'V2'},
-              ]}>
-              <TabItem value="v1">Tab 1</TabItem>
-              <TabItem value="v2">Tab 2</TabItem>
-            </Tabs>
-            <Tabs defaultValue={null}>
-              <TabItem value="v1" label="V1">
-                Tab 1
-              </TabItem>
-              <TabItem value="v2" label="V2">
-                Tab 2
-              </TabItem>
-            </Tabs>
-          </UserPreferencesProvider>
-        </ScrollControllerProvider>,
-      );
-    }).not.toThrow(); // TODO Better Jest infrastructure to mock the Layout
-  });
-  // https://github.com/facebook/docusaurus/issues/5729
-  test('Should accept dynamic Tabs with number values', () => {
-    expect(() => {
-      const tabs = ['Apple', 'Banana', 'Carrot'];
-      renderer.create(
-        <ScrollControllerProvider>
-          <UserPreferencesProvider>
-            <Tabs
-              values={tabs.map((t, idx) => ({label: t, value: idx}))}
-              defaultValue={0}>
-              {tabs.map((t, idx) => (
-                <TabItem value={idx}>{t}</TabItem>
-              ))}
-            </Tabs>
-          </UserPreferencesProvider>
-        </ScrollControllerProvider>,
-      );
-    }).not.toThrow();
-  });
-});

package/src/theme/ThemeContext.ts

@@ -1,15 +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 type {ThemeContextProps} from '@theme/hooks/useThemeContext';
-
-const ThemeContext = React.createContext<ThemeContextProps | undefined>(
-  undefined,
-);
-
-export default ThemeContext;

package/src/theme/ThemeProvider/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, {useMemo} 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();
-  const contextValue = useMemo(
-    () => ({isDarkTheme, setLightTheme, setDarkTheme}),
-    [isDarkTheme, setLightTheme, setDarkTheme],
-  );
-
-  return (
-    <ThemeContext.Provider value={contextValue}>
-      {props.children}
-    </ThemeContext.Provider>
-  );
-}
-
-export default ThemeProvider;

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,30 +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, {useMemo} from 'react';
-
-import useTabGroupChoice from '@theme/hooks/useTabGroupChoice';
-import UserPreferencesContext from '@theme/UserPreferencesContext';
-import type {Props} from '@theme/UserPreferencesProvider';
-
-function UserPreferencesProvider(props: Props): JSX.Element {
-  const {tabGroupChoices, setTabGroupChoices} = useTabGroupChoice();
-  const contextValue = useMemo(
-    () => ({
-      tabGroupChoices,
-      setTabGroupChoices,
-    }),
-    [tabGroupChoices, setTabGroupChoices],
-  );
-  return (
-    <UserPreferencesContext.Provider value={contextValue}>
-      {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/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,72 +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, useRef} from 'react';
-import {useLocationChange, useScrollPosition} from '@docusaurus/theme-common';
-import type {useHideableNavbarReturns} from '@theme/hooks/useHideableNavbar';
-
-const useHideableNavbar = (hideOnScroll: boolean): useHideableNavbarReturns => {
-  const [isNavbarVisible, setIsNavbarVisible] = useState(hideOnScroll);
-  const isFocusedAnchor = useRef(false);
-  const navbarHeight = useRef(0);
-  const navbarRef = useCallback((node: HTMLElement | null) => {
-    if (node !== null) {
-      navbarHeight.current = node.getBoundingClientRect().height;
-    }
-  }, []);
-
-  useScrollPosition((currentPosition, lastPosition) => {
-    if (!hideOnScroll) {
-      return;
-    }
-
-    const scrollTop = currentPosition.scrollY;
-
-    // It needed for mostly to handle rubber band scrolling
-    if (scrollTop < navbarHeight.current) {
-      setIsNavbarVisible(true);
-      return;
-    }
-
-    if (isFocusedAnchor.current) {
-      isFocusedAnchor.current = false;
-      return;
-    }
-
-    const lastScrollTop = lastPosition?.scrollY;
-    const documentHeight =
-      document.documentElement.scrollHeight - navbarHeight.current;
-    const windowHeight = window.innerHeight;
-
-    if (lastScrollTop && scrollTop >= lastScrollTop) {
-      setIsNavbarVisible(false);
-    } else if (scrollTop + windowHeight < documentHeight) {
-      setIsNavbarVisible(true);
-    }
-  });
-
-  useLocationChange((locationChangeEvent) => {
-    if (!hideOnScroll) {
-      return;
-    }
-
-    if (locationChangeEvent.location.hash) {
-      isFocusedAnchor.current = true;
-      setIsNavbarVisible(false);
-      return;
-    }
-
-    setIsNavbarVisible(true);
-  });
-
-  return {
-    navbarRef,
-    isNavbarVisible,
-  };
-};
-
-export default useHideableNavbar;

package/src/theme/hooks/useKeyboardNavigation.ts

@@ -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 {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(): void {
-  useEffect(() => {
-    const keyboardFocusedClassName = 'navigation-with-keyboard';
-
-    function handleOutlineStyles(e: MouseEvent | KeyboardEvent) {
-      if (e.type === 'keydown' && (e as KeyboardEvent).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/src/theme/hooks/useLocationHash.ts

@@ -1,25 +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';
-import type {useLocationHashReturns} from '@theme/hooks/useLocationHash';
-
-function useLocationHash(initialHash: string): useLocationHashReturns {
-  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/src/theme/hooks/useLockBodyScroll.ts

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

package/src/theme/hooks/usePrismTheme.ts

@@ -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 defaultTheme from 'prism-react-renderer/themes/palenight';
-import useThemeContext from '@theme/hooks/useThemeContext';
-import {useThemeConfig} from '@docusaurus/theme-common';
-
-const usePrismTheme = (): typeof defaultTheme => {
-  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/src/theme/hooks/useTabGroupChoice.ts

@@ -1,46 +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 type {useTabGroupChoiceReturns} from '@theme/hooks/useTabGroupChoice';
-import {createStorageSlot, listStorageKeys} from '@docusaurus/theme-common';
-
-const TAB_CHOICE_PREFIX = 'docusaurus.tab.';
-
-const useTabGroupChoice = (): useTabGroupChoiceReturns => {
-  const [tabGroupChoices, setChoices] = useState<{
-    readonly [groupId: string]: string;
-  }>({});
-  const setChoiceSyncWithLocalStorage = useCallback((groupId, newChoice) => {
-    createStorageSlot(`${TAB_CHOICE_PREFIX}${groupId}`).set(newChoice);
-  }, []);
-
-  useEffect(() => {
-    try {
-      const localStorageChoices: Record<string, string> = {};
-      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: string, newChoice: string) => {
-      setChoices((oldChoices) => ({...oldChoices, [groupId]: newChoice}));
-      setChoiceSyncWithLocalStorage(groupId, newChoice);
-    },
-  };
-};
-
-export default useTabGroupChoice;

package/src/theme/hooks/useTheme.ts

@@ -1,91 +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 type {useThemeReturns} from '@theme/hooks/useTheme';
-import {useThemeConfig, createStorageSlot} from '@docusaurus/theme-common';
-
-const ThemeStorage = createStorageSlot('theme');
-
-const themes = {
-  light: 'light',
-  dark: 'dark',
-} as const;
-
-type Themes = typeof themes[keyof typeof themes];
-
-// Ensure to always return a valid theme even if input is invalid
-const coerceToTheme = (theme?: string | null): Themes =>
-  theme === themes.dark ? themes.dark : themes.light;
-
-const getInitialTheme = (defaultMode: Themes | undefined): Themes => {
-  if (!ExecutionEnvironment.canUseDOM) {
-    return coerceToTheme(defaultMode);
-  }
-  return coerceToTheme(document.documentElement.getAttribute('data-theme'));
-};
-
-const storeTheme = (newTheme: Themes) => {
-  createStorageSlot('theme').set(coerceToTheme(newTheme));
-};
-
-const useTheme = (): useThemeReturns => {
-  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);
-    }
-  }, [disableSwitch, setTheme]);
-
-  useEffect(() => {
-    if (disableSwitch && !respectPrefersColorScheme) {
-      return;
-    }
-
-    window
-      .matchMedia('(prefers-color-scheme: dark)')
-      .addListener(({matches}) => {
-        setTheme(matches ? themes.dark : themes.light);
-      });
-  }, [disableSwitch, respectPrefersColorScheme]);
-
-  return {
-    isDarkTheme: theme === themes.dark,
-    setLightTheme,
-    setDarkTheme,
-  };
-};
-
-export default useTheme;

package/src/theme/hooks/useThemeContext.ts

@@ -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 {useContext} from 'react';
-
-import ThemeContext from '@theme/ThemeContext';
-import type {ThemeContextProps} from '@theme/hooks/useThemeContext';
-
-function useThemeContext(): ThemeContextProps {
-  const context = useContext<ThemeContextProps | undefined>(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/src/theme/hooks/useUserPreferencesContext.ts

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

package/src/theme/hooks/useWindowSize.ts

@@ -1,69 +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';
-import type {WindowSize} from '@theme/hooks/useWindowSize';
-
-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',
-} as const;
-
-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(): WindowSize {
-  const [windowSize, setWindowSize] = useState<WindowSize>(() => {
-    if (DevSimulateSSR) {
-      return 'ssr';
-    }
-    return getWindowSize();
-  });
-
-  useEffect(() => {
-    function updateWindowSize() {
-      setWindowSize(getWindowSize());
-    }
-
-    const timeout = DevSimulateSSR
-      ? window.setTimeout(updateWindowSize, 1000)
-      : undefined;
-
-    window.addEventListener('resize', updateWindowSize);
-
-    return () => {
-      window.removeEventListener('resize', updateWindowSize);
-      clearTimeout(timeout);
-    };
-  }, []);
-
-  return windowSize;
-}
-
-export default useWindowSize;