@docusaurus/theme-classic 2.0.0-beta.20 → 2.0.0-beta.21

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

@@ -5,21 +5,20 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React from 'react';
+import clsx from 'clsx';
 import {
   ThemeClassNames,
   useSidebarBreadcrumbs,
   useHomePageRoute,
 } from '@docusaurus/theme-common';
-import styles from './styles.module.css';
-import clsx from 'clsx';
 import Link from '@docusaurus/Link';
 import useBaseUrl from '@docusaurus/useBaseUrl';
 import {translate} from '@docusaurus/Translate';
-import IconHome from '@theme/IconHome'; // TODO move to design system folder
-
+import IconHome from '@theme/IconHome';
+import styles from './styles.module.css';
+// TODO move to design system folder
 function BreadcrumbsItemLink({children, href, isLast}) {
   const className = 'breadcrumbs__link';
-
   if (isLast) {
     return (
       <span className={className} itemProp="name">
@@ -27,20 +26,20 @@ function BreadcrumbsItemLink({children, href, isLast}) {
       </span>
     );
   }
-
   return href ? (
     <Link className={className} href={href} itemProp="item">
       <span itemProp="name">{children}</span>
-    </Link> // TODO Google search console doesn't like breadcrumb items without href.
+    </Link>
   ) : (
+    // TODO Google search console doesn't like breadcrumb items without href.
     // The schema doesn't seem to require `id` for each `item`, although Google
     // insist to infer one, even if it's invalid. Removing `itemProp="item
     // name"` for now, since I don't know how to properly fix it.
     // See https://github.com/facebook/docusaurus/issues/7241
     <span className={className}>{children}</span>
   );
-} // TODO move to design system folder
-
+}
+// TODO move to design system folder
 function BreadcrumbsItem({children, active, index, addMicrodata}) {
   return (
     <li
@@ -57,7 +56,6 @@ function BreadcrumbsItem({children, active, index, addMicrodata}) {
     </li>
   );
 }
-
 function HomeBreadcrumbItem() {
   const homeHref = useBaseUrl('/');
   return (
@@ -75,15 +73,12 @@ function HomeBreadcrumbItem() {
     </li>
   );
 }
-
 export default function DocBreadcrumbs() {
   const breadcrumbs = useSidebarBreadcrumbs();
   const homePageRoute = useHomePageRoute();
-
   if (!breadcrumbs) {
     return null;
   }
-
   return (
     <nav
       className={clsx(

package/lib/theme/DocCard/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/DocCard';
+export default function DocCard({ item }: Props): JSX.Element;

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

@@ -5,13 +5,12 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React from 'react';
+import clsx from 'clsx';
 import Link from '@docusaurus/Link';
 import {findFirstCategoryLink, useDocById} from '@docusaurus/theme-common';
-import clsx from 'clsx';
-import styles from './styles.module.css';
 import isInternalUrl from '@docusaurus/isInternalUrl';
 import {translate} from '@docusaurus/Translate';
-
+import styles from './styles.module.css';
 function CardContainer({href, children}) {
   return (
     <Link
@@ -21,7 +20,6 @@ function CardContainer({href, children}) {
     </Link>
   );
 }
-
 function CardLayout({href, icon, title, description}) {
   return (
     <CardContainer href={href}>
@@ -38,14 +36,12 @@ function CardLayout({href, icon, title, description}) {
     </CardContainer>
   );
 }
-
 function CardCategory({item}) {
-  const href = findFirstCategoryLink(item); // Unexpected: categories that don't have a link have been filtered upfront
-
+  const href = findFirstCategoryLink(item);
+  // Unexpected: categories that don't have a link have been filtered upfront
   if (!href) {
     return null;
   }
-
   return (
     <CardLayout
       href={href}
@@ -58,14 +54,11 @@ function CardCategory({item}) {
           description:
             'The default description for a category card in the generated index about how many items this category includes',
         },
-        {
-          count: item.items.length,
-        },
+        {count: item.items.length},
       )}
     />
   );
 }
-
 function CardLink({item}) {
   const icon = isInternalUrl(item.href) ? '📄️' : '🔗';
   const doc = useDocById(item.docId ?? undefined);
@@ -78,15 +71,12 @@ function CardLink({item}) {
     />
   );
 }
-
 export default function DocCard({item}) {
   switch (item.type) {
     case 'link':
       return <CardLink item={item} />;
-
     case 'category':
       return <CardCategory item={item} />;
-
     default:
       throw new Error(`unknown item type ${JSON.stringify(item)}`);
   }

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

@@ -6,20 +6,17 @@
  */
 import React from 'react';
 import clsx from 'clsx';
-import DocCard from '@theme/DocCard';
 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

@@ -9,26 +9,25 @@ import {
   PageMetadata,
   useCurrentSidebarCategory,
 } from '@docusaurus/theme-common';
+import useBaseUrl from '@docusaurus/useBaseUrl';
 import DocCardList from '@theme/DocCardList';
 import DocPaginator from '@theme/DocPaginator';
 import DocVersionBanner from '@theme/DocVersionBanner';
 import DocVersionBadge from '@theme/DocVersionBadge';
 import DocBreadcrumbs from '@theme/DocBreadcrumbs';
 import Heading from '@theme/Heading';
-import useBaseUrl from '@docusaurus/useBaseUrl';
 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

@@ -6,6 +6,12 @@
  */
 import React from 'react';
 import clsx from 'clsx';
+import {
+  PageMetadata,
+  HtmlClassNameProvider,
+  ThemeClassNames,
+  useWindowSize,
+} from '@docusaurus/theme-common';
 import DocPaginator from '@theme/DocPaginator';
 import DocVersionBanner from '@theme/DocVersionBanner';
 import DocVersionBadge from '@theme/DocVersionBadge';
@@ -13,34 +19,17 @@ import DocItemFooter from '@theme/DocItemFooter';
 import TOC from '@theme/TOC';
 import TOCCollapsible from '@theme/TOCCollapsible';
 import Heading from '@theme/Heading';
-import styles from './styles.module.css';
-import {
-  PageMetadata,
-  HtmlClassNameProvider,
-  ThemeClassNames,
-  useWindowSize,
-} from '@docusaurus/theme-common';
 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

@@ -6,12 +6,11 @@
  */
 import React from 'react';
 import clsx from 'clsx';
+import {ThemeClassNames} from '@docusaurus/theme-common';
 import LastUpdated from '@theme/LastUpdated';
 import EditThisPage from '@theme/EditThisPage';
 import TagsListInline from '@theme/TagsListInline';
 import styles from './styles.module.css';
-import {ThemeClassNames} from '@docusaurus/theme-common';
-
 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-next → lib}/theme/DocPage/Layout/Main/index.js

@@ -5,8 +5,8 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React from 'react';
-import {useDocsSidebar} from '@docusaurus/theme-common';
 import clsx from 'clsx';
+import {useDocsSidebar} from '@docusaurus/theme-common';
 import styles from './styles.module.css';
 export default function DocPageLayoutMain({hiddenSidebarContainer, children}) {
   const sidebar = useDocsSidebar();

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-next → lib}/theme/DocPage/Layout/Sidebar/ExpandButton/index.js

@@ -5,8 +5,8 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React from 'react';
-import IconArrow from '@theme/IconArrow';
 import {translate} from '@docusaurus/Translate';
+import IconArrow from '@theme/IconArrow';
 import styles from './styles.module.css';
 export default function DocPageLayoutSidebarExpandButton({toggleSidebar}) {
   return (

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

@@ -5,15 +5,15 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React, {useState, useCallback} from 'react';
-import DocSidebar from '@theme/DocSidebar';
+import clsx from 'clsx';
+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 clsx from 'clsx';
-import styles from './index.module.css';
-import {ThemeClassNames, useDocsSidebar} from '@docusaurus/theme-common'; // 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-next → lib}/theme/DocPage/Layout/index.js

@@ -5,12 +5,12 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React, {useState} from 'react';
+import {useDocsSidebar} from '@docusaurus/theme-common';
 import Layout from '@theme/Layout';
 import BackToTopButton from '@theme/BackToTopButton';
 import DocPageLayoutSidebar from '@theme/DocPage/Layout/Sidebar';
 import DocPageLayoutMain from '@theme/DocPage/Layout/Main';
-import styles from './index.module.css';
-import {useDocsSidebar} from '@docusaurus/theme-common';
+import styles from './styles.module.css';
 export default function DocPageLayout({children}) {
   const sidebar = useDocsSidebar();
   const [hiddenSidebarContainer, setHiddenSidebarContainer] = useState(false);

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

@@ -5,8 +5,6 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React from 'react';
-import NotFound from '@theme/NotFound';
-import DocPageLayout from '@theme/DocPage/Layout';
 import clsx from 'clsx';
 import {
   HtmlClassNameProvider,
@@ -16,15 +14,15 @@ import {
   DocsVersionProvider,
   useDocRouteMetadata,
 } from '@docusaurus/theme-common';
+import DocPageLayout from '@theme/DocPage/Layout';
+import NotFound from '@theme/NotFound';
 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-next → lib}/theme/DocSidebar/Desktop/CollapseButton/index.js

@@ -6,8 +6,8 @@
  */
 import React from 'react';
 import clsx from 'clsx';
-import IconArrow from '@theme/IconArrow';
 import {translate} from '@docusaurus/Translate';
+import IconArrow from '@theme/IconArrow';
 import styles from './styles.module.css';
 export default function CollapseButton({onClick}) {
   return (

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 (