@docusaurus/theme-classic 0.0.0-5030 → 0.0.0-5031

package/lib/theme/DocCardList/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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.
+ */
+/// <reference types="react" />
+import type { Props } from '@theme/DocCardList';
+export default function DocCardList({ items, className }: Props): JSX.Element;

package/{lib-next → lib}/theme/DocCardList/index.js

@@ -8,18 +8,15 @@ import React from 'react';
 import clsx from 'clsx';
 import {findFirstCategoryLink} from '@docusaurus/theme-common';
 import DocCard from '@theme/DocCard';
-
 // Filter categories that don't have a link.
 function filterItems(items) {
   return items.filter((item) => {
     if (item.type === 'category') {
       return !!findFirstCategoryLink(item);
     }
-
     return true;
   });
 }
-
 export default function DocCardList({items, className}) {
   return (
     <section className={clsx('row', className)}>

package/lib/theme/DocCategoryGeneratedIndexPage/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 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.
+ */
+/// <reference types="@docusaurus/plugin-content-docs" />
+/// <reference types="react" />
+import type { Props } from '@theme/DocCategoryGeneratedIndexPage';
+export default function DocCategoryGeneratedIndexPage(props: Props): JSX.Element;

package/{lib-next → lib}/theme/DocCategoryGeneratedIndexPage/index.js

@@ -17,18 +17,17 @@ import DocVersionBadge from '@theme/DocVersionBadge';
 import DocBreadcrumbs from '@theme/DocBreadcrumbs';
 import Heading from '@theme/Heading';
 import styles from './styles.module.css';
-
 function DocCategoryGeneratedIndexPageMetadata({categoryGeneratedIndex}) {
   return (
     <PageMetadata
       title={categoryGeneratedIndex.title}
       description={categoryGeneratedIndex.description}
-      keywords={categoryGeneratedIndex.keywords} // TODO `require` this?
+      keywords={categoryGeneratedIndex.keywords}
+      // TODO `require` this?
       image={useBaseUrl(categoryGeneratedIndex.image)}
     />
   );
 }
-
 function DocCategoryGeneratedIndexPageContent({categoryGeneratedIndex}) {
   const category = useCurrentSidebarCategory();
   return (
@@ -36,7 +35,8 @@ function DocCategoryGeneratedIndexPageContent({categoryGeneratedIndex}) {
       <PageMetadata
         title={categoryGeneratedIndex.title}
         description={categoryGeneratedIndex.description}
-        keywords={categoryGeneratedIndex.keywords} // TODO `require` this?
+        keywords={categoryGeneratedIndex.keywords}
+        // TODO `require` this?
         image={useBaseUrl(categoryGeneratedIndex.image)}
       />
       <div className={styles.generatedIndexPage}>
@@ -64,7 +64,6 @@ function DocCategoryGeneratedIndexPageContent({categoryGeneratedIndex}) {
     </>
   );
 }
-
 export default function DocCategoryGeneratedIndexPage(props) {
   return (
     <>

package/lib/theme/DocItem/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 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.
+ */
+/// <reference types="@docusaurus/plugin-content-docs" />
+/// <reference types="react" />
+import type { Props } from '@theme/DocItem';
+export default function DocItem(props: Props): JSX.Element;

package/{lib-next → lib}/theme/DocItem/index.js

@@ -22,25 +22,14 @@ import Heading from '@theme/Heading';
 import DocBreadcrumbs from '@theme/DocBreadcrumbs';
 import MDXContent from '@theme/MDXContent';
 import styles from './styles.module.css';
-
 function DocItemMetadata(props) {
   const {content: DocContent} = props;
   const {metadata, frontMatter, assets} = DocContent;
   const {keywords} = frontMatter;
   const {description, title} = metadata;
   const image = assets.image ?? frontMatter.image;
-  return (
-    <PageMetadata
-      {...{
-        title,
-        description,
-        keywords,
-        image,
-      }}
-    />
-  );
+  return <PageMetadata {...{title, description, keywords, image}} />;
 }
-
 function DocItemContent(props) {
   const {content: DocContent} = props;
   const {metadata, frontMatter} = DocContent;
@@ -50,10 +39,10 @@ function DocItemContent(props) {
     toc_min_heading_level: tocMinHeadingLevel,
     toc_max_heading_level: tocMaxHeadingLevel,
   } = frontMatter;
-  const {title} = metadata; // We only add a title if:
+  const {title} = metadata;
+  // We only add a title if:
   // - user doesn't ask to hide it with front matter
   // - the markdown content does not already contain a top-level h1 heading
-
   const shouldAddTitle =
     !hideTitle && typeof DocContent.contentTitle === 'undefined';
   const windowSize = useWindowSize();
@@ -84,11 +73,11 @@ function DocItemContent(props) {
 
             <div className={clsx(ThemeClassNames.docs.docMarkdown, 'markdown')}>
               {/*
-               Title can be declared inside md content or declared through
-               front matter and added manually. To make both cases consistent,
-               the added title is added under the same div.markdown block
-               See https://github.com/facebook/docusaurus/pull/4882#issuecomment-853021120
-               */}
+          Title can be declared inside md content or declared through
+          front matter and added manually. To make both cases consistent,
+          the added title is added under the same div.markdown block
+          See https://github.com/facebook/docusaurus/pull/4882#issuecomment-853021120
+          */}
               {shouldAddTitle && (
                 <header>
                   <Heading as="h1">{title}</Heading>
@@ -118,7 +107,6 @@ function DocItemContent(props) {
     </div>
   );
 }
-
 export default function DocItem(props) {
   const docHtmlClassName = `docs-doc-id-${props.content.metadata.unversionedId}`;
   return (

package/lib/theme/DocItemFooter/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 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.
+ */
+/// <reference types="@docusaurus/plugin-content-docs" />
+/// <reference types="react" />
+import type { Props } from '@theme/DocItem';
+export default function DocItemFooter(props: Props): JSX.Element | null;

package/{lib-next → lib}/theme/DocItemFooter/index.js

@@ -11,7 +11,6 @@ import LastUpdated from '@theme/LastUpdated';
 import EditThisPage from '@theme/EditThisPage';
 import TagsListInline from '@theme/TagsListInline';
 import styles from './styles.module.css';
-
 function TagsRow(props) {
   return (
     <div
@@ -25,7 +24,6 @@ function TagsRow(props) {
     </div>
   );
 }
-
 function EditMetaRow({
   editUrl,
   lastUpdatedAt,
@@ -48,7 +46,6 @@ function EditMetaRow({
     </div>
   );
 }
-
 export default function DocItemFooter(props) {
   const {content: DocContent} = props;
   const {metadata} = DocContent;
@@ -57,11 +54,9 @@ export default function DocItemFooter(props) {
   const canDisplayTagsRow = tags.length > 0;
   const canDisplayEditMetaRow = !!(editUrl || lastUpdatedAt || lastUpdatedBy);
   const canDisplayFooter = canDisplayTagsRow || canDisplayEditMetaRow;
-
   if (!canDisplayFooter) {
     return null;
   }
-
   return (
     <footer
       className={clsx(ThemeClassNames.docs.docFooter, 'docusaurus-mt-lg')}>

package/lib/theme/DocPage/Layout/Main/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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.
+ */
+/// <reference types="react" />
+import type { Props } from '@theme/DocPage/Layout/Main';
+export default function DocPageLayoutMain({ hiddenSidebarContainer, children, }: Props): JSX.Element;

package/lib/theme/DocPage/Layout/Sidebar/ExpandButton/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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.
+ */
+/// <reference types="react" />
+import type { Props } from '@theme/DocPage/Layout/Sidebar/ExpandButton';
+export default function DocPageLayoutSidebarExpandButton({ toggleSidebar, }: Props): JSX.Element;

package/lib/theme/DocPage/Layout/Sidebar/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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.
+ */
+/// <reference types="react" />
+import type { Props } from '@theme/DocPage/Layout/Sidebar';
+export default function DocPageLayoutSidebar({ sidebar, hiddenSidebarContainer, setHiddenSidebarContainer, }: Props): JSX.Element;

package/{lib-next → lib}/theme/DocPage/Layout/Sidebar/index.js

@@ -10,10 +10,10 @@ import {ThemeClassNames, useDocsSidebar} from '@docusaurus/theme-common';
 import {useLocation} from '@docusaurus/router';
 import DocSidebar from '@theme/DocSidebar';
 import ExpandButton from '@theme/DocPage/Layout/Sidebar/ExpandButton';
-import styles from './styles.module.css'; // Reset sidebar state when sidebar changes
+import styles from './styles.module.css';
+// Reset sidebar state when sidebar changes
 // Use React key to unmount/remount the children
 // See https://github.com/facebook/docusaurus/issues/3414
-
 function ResetOnSidebarChange({children}) {
   const sidebar = useDocsSidebar();
   return (
@@ -22,7 +22,6 @@ function ResetOnSidebarChange({children}) {
     </React.Fragment>
   );
 }
-
 export default function DocPageLayoutSidebar({
   sidebar,
   hiddenSidebarContainer,
@@ -34,7 +33,6 @@ export default function DocPageLayoutSidebar({
     if (hiddenSidebar) {
       setHiddenSidebar(false);
     }
-
     setHiddenSidebarContainer((value) => !value);
   }, [setHiddenSidebarContainer, hiddenSidebar]);
   return (
@@ -48,7 +46,6 @@ export default function DocPageLayoutSidebar({
         if (!e.currentTarget.classList.contains(styles.docSidebarContainer)) {
           return;
         }
-
         if (hiddenSidebarContainer) {
           setHiddenSidebar(true);
         }

package/lib/theme/DocPage/Layout/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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.
+ */
+/// <reference types="react" />
+import type { Props } from '@theme/DocPage/Layout';
+export default function DocPageLayout({ children }: Props): JSX.Element;

package/lib/theme/DocPage/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 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.
+ */
+/// <reference types="@docusaurus/plugin-content-docs" />
+/// <reference types="react" />
+import type { Props } from '@theme/DocPage';
+export default function DocPage(props: Props): JSX.Element;

package/{lib-next → lib}/theme/DocPage/index.js

@@ -20,11 +20,9 @@ import SearchMetadata from '@theme/SearchMetadata';
 export default function DocPage(props) {
   const {versionMetadata} = props;
   const currentDocRouteMetadata = useDocRouteMetadata(props);
-
   if (!currentDocRouteMetadata) {
     return <NotFound />;
   }
-
   const {docElement, sidebarName, sidebarItems} = currentDocRouteMetadata;
   return (
     <>

package/lib/theme/DocPaginator/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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.
+ */
+/// <reference types="react" />
+import type { Props } from '@theme/DocPaginator';
+export default function DocPaginator(props: Props): JSX.Element;

package/lib/theme/DocSidebar/Desktop/CollapseButton/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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.
+ */
+/// <reference types="react" />
+import type { Props } from '@theme/DocSidebar/Desktop/CollapseButton';
+export default function CollapseButton({ onClick }: Props): JSX.Element;

package/lib/theme/DocSidebar/Desktop/Content/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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.
+ */
+/// <reference types="react" />
+import type { Props } from '@theme/DocSidebar/Desktop/Content';
+export default function DocSidebarDesktopContent({ path, sidebar, className, }: Props): JSX.Element;

package/{lib-next → lib}/theme/DocSidebar/Desktop/Content/index.js

@@ -13,7 +13,6 @@ import {
 } from '@docusaurus/theme-common';
 import DocSidebarItems from '@theme/DocSidebarItems';
 import styles from './styles.module.css';
-
 function useShowAnnouncementBar() {
   const {isActive} = useAnnouncementBar();
   const [showAnnouncementBar, setShowAnnouncementBar] = useState(isActive);
@@ -27,7 +26,6 @@ function useShowAnnouncementBar() {
   );
   return isActive && showAnnouncementBar;
 }
-
 export default function DocSidebarDesktopContent({path, sidebar, className}) {
   const showAnnouncementBar = useShowAnnouncementBar();
   return (

package/lib/theme/DocSidebar/Desktop/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 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 { Props } from '@theme/DocSidebar/Desktop';
+declare function DocSidebarDesktop({ path, sidebar, onCollapse, isHidden }: Props): JSX.Element;
+declare const _default: React.MemoExoticComponent<typeof DocSidebarDesktop>;
+export default _default;

package/{lib-next → lib}/theme/DocSidebar/Desktop/index.js

@@ -11,7 +11,6 @@ import Logo from '@theme/Logo';
 import CollapseButton from '@theme/DocSidebar/Desktop/CollapseButton';
 import Content from '@theme/DocSidebar/Desktop/Content';
 import styles from './styles.module.css';
-
 function DocSidebarDesktop({path, sidebar, onCollapse, isHidden}) {
   const {
     navbar: {hideOnScroll},
@@ -32,5 +31,4 @@ function DocSidebarDesktop({path, sidebar, onCollapse, isHidden}) {
     </div>
   );
 }
-
 export default React.memo(DocSidebarDesktop);

package/lib/theme/DocSidebar/Mobile/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 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 { Props } from '@theme/DocSidebar/Mobile';
+declare function DocSidebarMobile(props: Props): JSX.Element;
+declare const _default: React.MemoExoticComponent<typeof DocSidebarMobile>;
+export default _default;

package/{lib-next → lib}/theme/DocSidebar/Mobile/index.js

@@ -12,7 +12,6 @@ import {
   useNavbarMobileSidebar,
 } from '@docusaurus/theme-common';
 import DocSidebarItems from '@theme/DocSidebarItems';
-
 // eslint-disable-next-line react/function-component-definition
 const DocSidebarMobileSecondaryMenu = ({sidebar, path}) => {
   const mobileSidebar = useNavbarMobileSidebar();
@@ -26,7 +25,6 @@ const DocSidebarMobileSecondaryMenu = ({sidebar, path}) => {
           if (item.type === 'category' && item.href) {
             mobileSidebar.toggle();
           }
-
           if (item.type === 'link') {
             mobileSidebar.toggle();
           }
@@ -36,7 +34,6 @@ const DocSidebarMobileSecondaryMenu = ({sidebar, path}) => {
     </ul>
   );
 };
-
 function DocSidebarMobile(props) {
   return (
     <NavbarSecondaryMenuFiller
@@ -45,5 +42,4 @@ function DocSidebarMobile(props) {
     />
   );
 }
-
 export default React.memo(DocSidebarMobile);

package/lib/theme/DocSidebar/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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.
+ */
+/// <reference types="react" />
+import type { Props } from '@theme/DocSidebar';
+export default function DocSidebar(props: Props): JSX.Element;

package/{lib-next → lib}/theme/DocSidebar/index.js

@@ -9,11 +9,11 @@ import {useWindowSize} from '@docusaurus/theme-common';
 import DocSidebarDesktop from '@theme/DocSidebar/Desktop';
 import DocSidebarMobile from '@theme/DocSidebar/Mobile';
 export default function DocSidebar(props) {
-  const windowSize = useWindowSize(); // Desktop sidebar visible on hydration: need SSR rendering
-
+  const windowSize = useWindowSize();
+  // Desktop sidebar visible on hydration: need SSR rendering
   const shouldRenderSidebarDesktop =
-    windowSize === 'desktop' || windowSize === 'ssr'; // Mobile sidebar not visible on hydration: can avoid SSR rendering
-
+    windowSize === 'desktop' || windowSize === 'ssr';
+  // Mobile sidebar not visible on hydration: can avoid SSR rendering
   const shouldRenderSidebarMobile = windowSize === 'mobile';
   return (
     <>

package/lib/theme/DocSidebarItem/Category/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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.
+ */
+/// <reference types="react" />
+import type { Props } from '@theme/DocSidebarItem/Category';
+export default function DocSidebarItemCategory({ item, onItemClick, activePath, level, index, ...props }: Props): JSX.Element;

package/{lib-next → lib}/theme/DocSidebarItem/Category/index.js

@@ -21,14 +21,12 @@ import Link from '@docusaurus/Link';
 import {translate} from '@docusaurus/Translate';
 import useIsBrowser from '@docusaurus/useIsBrowser';
 import DocSidebarItems from '@theme/DocSidebarItems';
-
 // If we navigate to a category and it becomes active, it should automatically
 // expand itself
 function useAutoExpandActiveCategory({isActive, collapsed, updateCollapsed}) {
   const wasActive = usePrevious(isActive);
   useEffect(() => {
     const justBecameActive = isActive && !wasActive;
-
     if (justBecameActive && collapsed) {
       updateCollapsed(false);
     }
@@ -42,23 +40,20 @@ function useAutoExpandActiveCategory({isActive, collapsed, updateCollapsed}) {
  * see https://github.com/facebookincubator/infima/issues/36#issuecomment-772543188
  * see https://github.com/facebook/docusaurus/issues/3030
  */
-
 function useCategoryHrefWithSSRFallback(item) {
   const isBrowser = useIsBrowser();
   return useMemo(() => {
     if (item.href) {
       return item.href;
-    } // In these cases, it's not necessary to render a fallback
+    }
+    // In these cases, it's not necessary to render a fallback
     // We skip the "findFirstCategoryLink" computation
-
     if (isBrowser || !item.collapsible) {
       return undefined;
     }
-
     return findFirstCategoryLink(item);
   }, [item, isBrowser]);
 }
-
 function CollapseButton({categoryLabel, onClick}) {
   return (
     <button
@@ -69,9 +64,7 @@ function CollapseButton({categoryLabel, onClick}) {
           description:
             'The ARIA label to toggle the collapsible sidebar category',
         },
-        {
-          label: categoryLabel,
-        },
+        {label: categoryLabel},
       )}
       type="button"
       className="clean-btn menu__caret"
@@ -79,7 +72,6 @@ function CollapseButton({categoryLabel, onClick}) {
     />
   );
 }
-
 export default function DocSidebarItemCategory({
   item,
   onItemClick,
@@ -104,22 +96,16 @@ export default function DocSidebarItemCategory({
       if (!collapsible) {
         return false;
       }
-
       return isActive ? false : item.collapsed;
     },
   });
-  const {expandedItem, setExpandedItem} = useDocSidebarItemsExpandedState(); // Use this instead of `setCollapsed`, because it is also reactive
-
+  const {expandedItem, setExpandedItem} = useDocSidebarItemsExpandedState();
+  // Use this instead of `setCollapsed`, because it is also reactive
   const updateCollapsed = (toCollapsed = !collapsed) => {
     setExpandedItem(toCollapsed ? null : index);
     setCollapsed(toCollapsed);
   };
-
-  useAutoExpandActiveCategory({
-    isActive,
-    collapsed,
-    updateCollapsed,
-  });
+  useAutoExpandActiveCategory({isActive, collapsed, updateCollapsed});
   useEffect(() => {
     if (
       collapsible &&
@@ -155,7 +141,6 @@ export default function DocSidebarItemCategory({
             collapsible
               ? (e) => {
                   onItemClick?.(item);
-
                   if (href) {
                     updateCollapsed(false);
                   } else {

package/lib/theme/DocSidebarItem/Html/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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.
+ */
+/// <reference types="react" />
+import type { Props } from '@theme/DocSidebarItem/Html';
+export default function DocSidebarItemHtml({ item, level, index, }: Props): JSX.Element;

package/{lib-next → lib}/theme/DocSidebarItem/Html/index.js

@@ -18,10 +18,9 @@ export default function DocSidebarItemHtml({item, level, index}) {
         defaultStyle && `${styles.menuHtmlItem} menu__list-item`,
         className,
       )}
-      key={index} // eslint-disable-next-line react/no-danger
-      dangerouslySetInnerHTML={{
-        __html: value,
-      }}
+      key={index}
+      // eslint-disable-next-line react/no-danger
+      dangerouslySetInnerHTML={{__html: value}}
     />
   );
 }

package/lib/theme/DocSidebarItem/Link/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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.
+ */
+/// <reference types="react" />
+import type { Props } from '@theme/DocSidebarItem/Link';
+export default function DocSidebarItemLink({ item, onItemClick, activePath, level, index, ...props }: Props): JSX.Element;