@docusaurus/theme-classic 0.0.0-4366 → 0.0.0-4377

package/src/theme-classic.d.ts

@@ -149,23 +149,33 @@ declare module '@theme/DocSidebar' {
 declare module '@theme/DocSidebarItem' {
   import type {PropSidebarItem} from '@docusaurus/plugin-content-docs';
 
-  type DocSidebarPropsBase = {
+  export type DocSidebarPropsBase = {
     readonly activePath: string;
     readonly onItemClick?: (item: PropSidebarItem) => void;
     readonly level: number;
     readonly tabIndex?: number;
   };
 
-  export interface Props extends DocSidebarPropsBase {
+  export interface Props {
+    readonly activePath: string;
+    readonly onItemClick?: (item: PropSidebarItem) => void;
+    readonly level: number;
+    readonly tabIndex?: number;
     readonly item: PropSidebarItem;
   }
-  const DocSidebarItem: (props: Props) => JSX.Element;
-  export default DocSidebarItem;
 
-  export type DocSidebarItemsProps = DocSidebarPropsBase & {
+  export default function DocSidebarItem(props: Props): JSX.Element;
+}
+
+declare module '@theme/DocSidebarItems' {
+  import type {Props as DocSidebarItemProps} from '@theme/DocSidebarItem';
+  import type {PropSidebarItem} from '@docusaurus/plugin-content-docs';
+
+  export type Props = Omit<DocSidebarItemProps, 'item'> & {
     readonly items: readonly PropSidebarItem[];
   };
-  export const DocSidebarItems: (props: DocSidebarItemsProps) => JSX.Element;
+
+  export default function DocSidebarItems(props: Props): JSX.Element;
 }
 
 declare module '@theme/DocVersionSuggestions' {
@@ -196,92 +206,13 @@ declare module '@theme/Footer' {
 declare module '@theme/Heading' {
   import type {ComponentProps} from 'react';
 
-  export type HeadingType = 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6';
-  export interface Props extends ComponentProps<HeadingType> {}
-
-  const Heading: (Tag: HeadingType) => (props: Props) => JSX.Element;
-  export default Heading;
-  export const MainHeading: (props: Props) => JSX.Element;
-}
-
-declare module '@theme/hooks/useHideableNavbar' {
-  export type useHideableNavbarReturns = {
-    readonly navbarRef: (node: HTMLElement | null) => void;
-    readonly isNavbarVisible: boolean;
-  };
-
-  const useHideableNavbar: (hideOnScroll: boolean) => useHideableNavbarReturns;
-  export default useHideableNavbar;
-}
-
-declare module '@theme/hooks/useLockBodyScroll' {
-  const useLockBodyScroll: (lock?: boolean) => void;
-  export default useLockBodyScroll;
-}
-
-declare module '@theme/hooks/usePrismTheme' {
-  import type defaultTheme from 'prism-react-renderer/themes/palenight';
-
-  const usePrismTheme: () => typeof defaultTheme;
-  export default usePrismTheme;
-}
-
-declare module '@theme/hooks/useTabGroupChoice' {
-  export type useTabGroupChoiceReturns = {
-    readonly tabGroupChoices: {readonly [groupId: string]: string};
-    readonly setTabGroupChoices: (groupId: string, newChoice: string) => void;
-  };
-
-  const useTabGroupChoice: () => useTabGroupChoiceReturns;
-  export default useTabGroupChoice;
-}
-
-declare module '@theme/hooks/useTheme' {
-  export type useThemeReturns = {
-    readonly isDarkTheme: boolean;
-    readonly setLightTheme: () => void;
-    readonly setDarkTheme: () => void;
-  };
+  type HeadingType = 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6';
 
-  const useTheme: () => useThemeReturns;
-  export default useTheme;
-}
-
-declare module '@theme/hooks/useThemeContext' {
-  export type ThemeContextProps = {
-    isDarkTheme: boolean;
-    setLightTheme: () => void;
-    setDarkTheme: () => void;
-  };
-
-  export default function useThemeContext(): ThemeContextProps;
-}
-
-declare module '@theme/hooks/useUserPreferencesContext' {
-  export type UserPreferencesContextProps = {
-    tabGroupChoices: {readonly [groupId: string]: string};
-    setTabGroupChoices: (groupId: string, newChoice: string) => void;
-  };
-
-  export default function useUserPreferencesContext(): UserPreferencesContextProps;
-}
-
-declare module '@theme/hooks/useWindowSize' {
-  export const windowSizes: {
-    desktop: 'desktop';
-    mobile: 'mobile';
-    ssr: 'ssr';
-  };
-
-  export type WindowSize = keyof typeof windowSizes;
-
-  export default function useWindowSize(): WindowSize;
-}
-
-declare module '@theme/hooks/useKeyboardNavigation' {
-  const useKeyboardNavigation: () => void;
+  export interface Props extends ComponentProps<HeadingType> {
+    as: HeadingType;
+  }
 
-  export default useKeyboardNavigation;
+  export default function Heading(props: Props): JSX.Element;
 }
 
 declare module '@theme/Layout' {
@@ -303,8 +234,7 @@ declare module '@theme/Layout' {
     };
   }
 
-  const Layout: (props: Props) => JSX.Element;
-  export default Layout;
+  export default function Layout(props: Props): JSX.Element;
 }
 
 declare module '@theme/LayoutHead' {
@@ -312,8 +242,17 @@ declare module '@theme/LayoutHead' {
 
   export interface Props extends Omit<LayoutProps, 'children'> {}
 
-  const LayoutHead: (props: Props) => JSX.Element;
-  export default LayoutHead;
+  export default function LayoutHead(props: Props): JSX.Element;
+}
+
+declare module '@theme/LayoutProviders' {
+  import type {ReactNode} from 'react';
+
+  export interface Props {
+    readonly children: ReactNode;
+  }
+
+  export default function LayoutProviders(props: Props): JSX.Element;
 }
 
 declare module '@theme/SearchMetadata' {
@@ -372,18 +311,9 @@ declare module '@theme/Navbar' {
 }
 
 declare module '@theme/NavbarItem/DefaultNavbarItem' {
-  import type {ReactNode} from 'react';
-  import type {LinkProps} from '@docusaurus/Link';
-
-  export type NavLinkProps = LinkProps & {
-    readonly activeBasePath?: string;
-    readonly activeBaseRegex?: string;
-    readonly exact?: boolean;
-    readonly label?: ReactNode;
-    readonly prependBaseUrlToHref?: string;
-  };
+  import type {Props as NavbarNavLinkProps} from '@theme/NavbarItem/NavbarNavLink';
 
-  export type DesktopOrMobileNavBarItemProps = NavLinkProps & {
+  export type DesktopOrMobileNavBarItemProps = NavbarNavLinkProps & {
     readonly isDropdownItem?: boolean;
     readonly className?: string;
     readonly position?: 'left' | 'right';
@@ -393,17 +323,30 @@ declare module '@theme/NavbarItem/DefaultNavbarItem' {
     readonly mobile?: boolean;
   }
 
-  export const NavLink: (props: NavLinkProps) => JSX.Element;
+  export default function DefaultNavbarItem(props: Props): JSX.Element;
+}
 
-  const DefaultNavbarItem: (props: Props) => JSX.Element;
-  export default DefaultNavbarItem;
+declare module '@theme/NavbarItem/NavbarNavLink' {
+  import type {ReactNode} from 'react';
+  import type {LinkProps} from '@docusaurus/Link';
+
+  export type Props = LinkProps & {
+    readonly activeBasePath?: string;
+    readonly activeBaseRegex?: string;
+    readonly exact?: boolean;
+    readonly label?: ReactNode;
+    readonly prependBaseUrlToHref?: string;
+  };
+
+  export default function NavbarNavLink(props: Props): JSX.Element;
 }
 
 declare module '@theme/NavbarItem/DropdownNavbarItem' {
-  import type {NavLinkProps} from '@theme/NavbarItem/DefaultNavbarItem';
+  import type {Props as NavbarNavLinkProps} from '@theme/NavbarItem/NavbarNavLink';
+
   import type {LinkLikeNavbarItemProps} from '@theme/NavbarItem';
 
-  export type DesktopOrMobileNavBarItemProps = NavLinkProps & {
+  export type DesktopOrMobileNavBarItemProps = NavbarNavLinkProps & {
     readonly position?: 'left' | 'right';
     readonly items: readonly LinkLikeNavbarItemProps[];
     readonly className?: string;
@@ -526,6 +469,10 @@ declare module '@theme/NavbarItem' {
   export default NavbarItem;
 }
 
+declare module '@theme/NavbarItem/utils' {
+  export function getInfimaActiveClassName(mobile?: boolean): string;
+}
+
 declare module '@theme/PaginatorNavLink' {
   import type {ReactNode} from 'react';
   import type {PropNavigationLink} from '@docusaurus/plugin-content-docs';
@@ -602,17 +549,6 @@ declare module '@theme/Details' {
   export default Details;
 }
 
-declare module '@theme/ThemeProvider' {
-  import type {ReactNode} from 'react';
-
-  export interface Props {
-    readonly children: ReactNode;
-  }
-
-  const ThemeProvider: (props: Props) => JSX.Element;
-  export default ThemeProvider;
-}
-
 declare module '@theme/TOCItems' {
   import type {TOCItem} from '@docusaurus/types';
 
@@ -693,46 +629,6 @@ declare module '@theme/Toggle' {
   export default Toggle;
 }
 
-declare module '@theme/UserPreferencesProvider' {
-  import type {ReactNode} from 'react';
-
-  export interface Props {
-    readonly children: ReactNode;
-  }
-
-  const UserPreferencesProvider: (props: Props) => JSX.Element;
-  export default UserPreferencesProvider;
-}
-
-declare module '@theme/LayoutProviders' {
-  import type {ReactNode} from 'react';
-
-  export interface Props {
-    readonly children: ReactNode;
-  }
-
-  const LayoutProviders: (props: Props) => JSX.Element;
-  export default LayoutProviders;
-}
-
-declare module '@theme/ThemeContext' {
-  import type {Context} from 'react';
-  import type {ThemeContextProps} from '@theme/hooks/useThemeContext';
-
-  const ThemeContext: Context<ThemeContextProps | undefined>;
-  export default ThemeContext;
-}
-
-declare module '@theme/UserPreferencesContext' {
-  import type {Context} from 'react';
-  import type {UserPreferencesContextProps} from '@theme/hooks/useUserPreferencesContext';
-
-  const UserPreferencesContext: Context<
-    UserPreferencesContextProps | undefined
-  >;
-  export default UserPreferencesContext;
-}
-
 declare module '@theme/Logo' {
   import type {ComponentProps} from 'react';
 

package/lib-next/theme/ThemeProvider/index.js

@@ -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';
-
-function ThemeProvider(props) {
-  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/lib-next/theme/UserPreferencesContext.js

@@ -1,9 +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/lib-next/theme/UserPreferencesProvider/index.js

@@ -1,27 +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';
-
-function UserPreferencesProvider(props) {
-  const {tabGroupChoices, setTabGroupChoices} = useTabGroupChoice();
-  const contextValue = useMemo(
-    () => ({
-      tabGroupChoices,
-      setTabGroupChoices,
-    }),
-    [tabGroupChoices, setTabGroupChoices],
-  );
-  return (
-    <UserPreferencesContext.Provider value={contextValue}>
-      {props.children}
-    </UserPreferencesContext.Provider>
-  );
-}
-
-export default UserPreferencesProvider;

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

@@ -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.
- */
-// 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/lib-next/theme/hooks/useHideableNavbar.js

@@ -1,66 +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';
-
-const useHideableNavbar = (hideOnScroll) => {
-  const [isNavbarVisible, setIsNavbarVisible] = useState(hideOnScroll);
-  const isFocusedAnchor = useRef(false);
-  const navbarHeight = useRef(0);
-  const navbarRef = useCallback((node) => {
-    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/lib-next/theme/hooks/useKeyboardNavigation.js

@@ -1,35 +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() {
-  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);
-    };
-  }, []);
-}
-
-export default useKeyboardNavigation;

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

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

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

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

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

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

@@ -1,81 +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) =>
-  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);
-    }
-  }, [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/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;