@docusaurus/theme-classic 0.0.0-5029 → 0.0.0-5032

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

@@ -15,8 +15,8 @@ import MDXContent from '@theme/MDXContent';
 import EditThisPage from '@theme/EditThisPage';
 import TagsListInline from '@theme/TagsListInline';
 import BlogPostAuthors from '@theme/BlogPostAuthors';
-import styles from './styles.module.css'; // Very simple pluralization: probably good enough for now
-
+import styles from './styles.module.css';
+// Very simple pluralization: probably good enough for now
 function useReadingTimePlural() {
   const {selectMessage} = usePluralForm();
   return (readingTimeFloat) => {
@@ -30,14 +30,11 @@ function useReadingTimePlural() {
             'Pluralized label for "{readingTime} min read". Use as much plural forms (separated by "|") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)',
           message: 'One min read|{readingTime} min read',
         },
-        {
-          readingTime,
-        },
+        {readingTime},
       ),
     );
   };
 }
-
 export default function BlogPostItem(props) {
   const readingTimePlural = useReadingTimePlural();
   const {withBaseUrl} = useBaseUrlUtils();
@@ -95,15 +92,11 @@ export default function BlogPostItem(props) {
       </header>
 
       {image && (
-        <meta
-          itemProp="image"
-          content={withBaseUrl(image, {
-            absolute: true,
-          })}
-        />
+        <meta itemProp="image" content={withBaseUrl(image, {absolute: true})} />
       )}
 
-      <div // This ID is used for the feed generation to locate the main content
+      <div
+        // This ID is used for the feed generation to locate the main content
         id={isBlogPostPage ? blogPostContainerID : undefined}
         className="markdown"
         itemProp="articleBody">
@@ -117,10 +110,7 @@ export default function BlogPostItem(props) {
             isBlogPostPage && styles.blogPostDetailsFull,
           )}>
           {tagsExists && (
-            <div
-              className={clsx('col', {
-                'col--9': truncatedPost,
-              })}>
+            <div className={clsx('col', {'col--9': truncatedPost})}>
               <TagsListInline tags={tags} />
             </div>
           )}
@@ -145,9 +135,7 @@ export default function BlogPostItem(props) {
                     description:
                       'The ARIA label for the link to full blog posts from excerpts',
                   },
-                  {
-                    title,
-                  },
+                  {title},
                 )}>
                 <b>
                   <Translate

package/lib/theme/BlogPostPage/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-blog" />
+/// <reference types="react" />
+import type { Props } from '@theme/BlogPostPage';
+export default function BlogPostPage(props: Props): JSX.Element;

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

@@ -15,7 +15,6 @@ import BlogLayout from '@theme/BlogLayout';
 import BlogPostItem from '@theme/BlogPostItem';
 import BlogPostPaginator from '@theme/BlogPostPaginator';
 import TOC from '@theme/TOC';
-
 function BlogPostPageMetadata(props) {
   const {content: BlogPostContents} = props;
   const {assets, metadata} = BlogPostContents;
@@ -49,7 +48,6 @@ function BlogPostPageMetadata(props) {
     </PageMetadata>
   );
 }
-
 function BlogPostPageContent(props) {
   const {content: BlogPostContents, sidebar} = props;
   const {assets, metadata} = BlogPostContents;
@@ -87,7 +85,6 @@ function BlogPostPageContent(props) {
     </BlogLayout>
   );
 }
-
 export default function BlogPostPage(props) {
   return (
     <HtmlClassNameProvider

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

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

package/lib/theme/BlogSidebar/Mobile/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/BlogSidebar/Mobile';
+export default function BlogSidebarMobile(props: Props): JSX.Element;

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

@@ -7,7 +7,6 @@
 import React from 'react';
 import Link from '@docusaurus/Link';
 import {NavbarSecondaryMenuFiller} from '@docusaurus/theme-common';
-
 function BlogSidebarMobileSecondaryMenu({sidebar}) {
   return (
     <ul className="menu__list">
@@ -25,7 +24,6 @@ function BlogSidebarMobileSecondaryMenu({sidebar}) {
     </ul>
   );
 }
-
 export default function BlogSidebarMobile(props) {
   return (
     <NavbarSecondaryMenuFiller

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

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

@@ -10,14 +10,12 @@ import BlogSidebarDesktop from '@theme/BlogSidebar/Desktop';
 import BlogSidebarMobile from '@theme/BlogSidebar/Mobile';
 export default function BlogSidebar({sidebar}) {
   const windowSize = useWindowSize();
-
   if (!sidebar?.items.length) {
     return null;
-  } // Mobile sidebar doesn't need to be server-rendered
-
+  }
+  // Mobile sidebar doesn't need to be server-rendered
   if (windowSize === 'mobile') {
     return <BlogSidebarMobile sidebar={sidebar} />;
   }
-
   return <BlogSidebarDesktop sidebar={sidebar} />;
 }

package/lib/theme/BlogTagsListPage/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-blog" />
+/// <reference types="react" />
+import type { Props } from '@theme/BlogTagsListPage';
+export default function BlogTagsListPage({ tags, sidebar }: Props): JSX.Element;

package/lib/theme/BlogTagsPostsPage/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-blog" />
+/// <reference types="react" />
+import type { Props } from '@theme/BlogTagsPostsPage';
+export default function BlogTagsPostsPage({ tag, items, sidebar, listMetadata, }: Props): JSX.Element;

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

@@ -18,7 +18,6 @@ import BlogLayout from '@theme/BlogLayout';
 import BlogPostItem from '@theme/BlogPostItem';
 import BlogListPaginator from '@theme/BlogListPaginator';
 import SearchMetadata from '@theme/SearchMetadata';
-
 // Very simple pluralization: probably good enough for now
 function useBlogPostsPlural() {
   const {selectMessage} = usePluralForm();
@@ -32,13 +31,10 @@ function useBlogPostsPlural() {
             'Pluralized label for "{count} posts". Use as much plural forms (separated by "|") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)',
           message: 'One post|{count} posts',
         },
-        {
-          count,
-        },
+        {count},
       ),
     );
 }
-
 export default function BlogTagsPostsPage({tag, items, sidebar, listMetadata}) {
   const blogPostsPlural = useBlogPostsPlural();
   const title = translate(
@@ -47,10 +43,7 @@ export default function BlogTagsPostsPage({tag, items, sidebar, listMetadata}) {
       description: 'The title of the page for a blog tag',
       message: '{nPosts} tagged with "{tagName}"',
     },
-    {
-      nPosts: blogPostsPlural(tag.count),
-      tagName: tag.label,
-    },
+    {nPosts: blogPostsPlural(tag.count), tagName: tag.label},
   );
   return (
     <HtmlClassNameProvider

package/lib/theme/CodeBlock/Container/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.
+ */
+import { type ComponentProps } from 'react';
+export default function CodeBlockContainer<T extends 'div' | 'pre'>({ as: As, ...props }: {
+    as: T;
+} & ComponentProps<T>): JSX.Element;

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

@@ -16,7 +16,8 @@ export default function CodeBlockContainer({as: As, ...props}) {
   const prismTheme = usePrismTheme();
   const prismCssVariables = getPrismCssVariables(prismTheme);
   return (
-    <As // Polymorphic components are hard to type, without `oneOf` generics
+    <As
+      // Polymorphic components are hard to type, without `oneOf` generics
       {...props}
       style={prismCssVariables}
       className={clsx(

package/lib/theme/CodeBlock/Content/Element.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/CodeBlock/Content/Element';
+export default function CodeBlockJSX({ children, className, }: Props): JSX.Element;

package/{lib-next → lib}/theme/CodeBlock/Content/Element.js

@@ -7,10 +7,10 @@
 import React from 'react';
 import clsx from 'clsx';
 import Container from '@theme/CodeBlock/Container';
-import styles from './styles.module.css'; // <pre> tags in markdown map to CodeBlocks. They may contain JSX children. When
+import styles from './styles.module.css';
+// <pre> tags in markdown map to CodeBlocks. They may contain JSX children. When
 // the children is not a simple string, we just return a styled block without
 // actually highlighting.
-
 export default function CodeBlockJSX({children, className}) {
   return (
     <Container

package/lib/theme/CodeBlock/Content/String.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/CodeBlock/Content/String';
+export default function CodeBlockString({ children, className: blockClassName, metastring, title: titleProp, showLineNumbers: showLineNumbersProp, language: languageProp, }: Props): JSX.Element;

package/{lib-next → lib}/theme/CodeBlock/Content/String.js

@@ -35,10 +35,10 @@ export default function CodeBlockString({
   const language =
     languageProp ?? parseLanguage(blockClassName) ?? defaultLanguage;
   const prismTheme = usePrismTheme();
-  const wordWrap = useCodeWordWrap(); // We still parse the metastring in case we want to support more syntax in the
+  const wordWrap = useCodeWordWrap();
+  // We still parse the metastring in case we want to support more syntax in the
   // future. Note that MDX doesn't strip quotes when parsing metastring:
   // "title=\"xyz\"" => title: "\"xyz\""
-
   const title = parseCodeBlockTitle(metastring) || titleProp;
   const {lineClassNames, code} = parseLines(children, {
     metastring,

package/lib/theme/CodeBlock/CopyButton/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/CodeBlock/CopyButton';
+export default function CopyButton({ code, className }: Props): JSX.Element;

package/lib/theme/CodeBlock/Line/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/CodeBlock/Line';
+export default function CodeBlockLine({ line, classNames, showLineNumbers, getLineProps, getTokenProps, }: Props): JSX.Element;

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

@@ -17,19 +17,12 @@ export default function CodeBlockLine({
   if (line.length === 1 && line[0].content === '\n') {
     line[0].content = '';
   }
-
   const lineProps = getLineProps({
     line,
     className: clsx(classNames, showLineNumbers && styles.codeLine),
   });
   const lineTokens = line.map((token, key) => (
-    <span
-      key={key}
-      {...getTokenProps({
-        token,
-        key,
-      })}
-    />
+    <span key={key} {...getTokenProps({token, key})} />
   ));
   return (
     <span {...lineProps}>

package/lib/theme/CodeBlock/WordWrapButton/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/CodeBlock/WordWrapButton';
+export default function WordWrapButton({ className, onClick, isEnabled, }: Props): JSX.Element | null;

package/lib/theme/CodeBlock/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/CodeBlock';
+export default function CodeBlock({ children: rawChildren, ...props }: Props): JSX.Element;

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

@@ -8,7 +8,6 @@ import React, {isValidElement} from 'react';
 import useIsBrowser from '@docusaurus/useIsBrowser';
 import ElementContent from '@theme/CodeBlock/Content/Element';
 import StringContent from '@theme/CodeBlock/Content/String';
-
 /**
  * Best attempt to make the children a plain string so it is copyable. If there
  * are react elements, we will not be able to copy the content, and it will
@@ -18,11 +17,10 @@ import StringContent from '@theme/CodeBlock/Content/String';
 function maybeStringifyChildren(children) {
   if (React.Children.toArray(children).some((el) => isValidElement(el))) {
     return children;
-  } // The children is now guaranteed to be one/more plain strings
-
+  }
+  // The children is now guaranteed to be one/more plain strings
   return Array.isArray(children) ? children.join('') : children;
 }
-
 export default function CodeBlock({children: rawChildren, ...props}) {
   // The Prism theme on SSR is always the default theme but the site theme can
   // be in a different mode. React hydration doesn't update DOM styles that come

package/lib/theme/ColorModeToggle/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/ColorModeToggle';
+declare function ColorModeToggle({ className, value, onChange }: Props): JSX.Element;
+declare const _default: React.MemoExoticComponent<typeof ColorModeToggle>;
+export default _default;

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

@@ -11,7 +11,6 @@ import {translate} from '@docusaurus/Translate';
 import IconLightMode from '@theme/IconLightMode';
 import IconDarkMode from '@theme/IconDarkMode';
 import styles from './styles.module.css';
-
 function ColorModeToggle({className, value, onChange}) {
   const isBrowser = useIsBrowser();
   const title = translate(
@@ -58,5 +57,4 @@ function ColorModeToggle({className, value, onChange}) {
     </div>
   );
 }
-
 export default React.memo(ColorModeToggle);

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

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

@@ -7,9 +7,9 @@
 import React from 'react';
 import clsx from 'clsx';
 import {Details as DetailsGeneric} from '@docusaurus/theme-common/Details';
-import styles from './styles.module.css'; // Should we have a custom details/summary comp in Infima instead of reusing
+import styles from './styles.module.css';
+// Should we have a custom details/summary comp in Infima instead of reusing
 // alert classes?
-
 const InfimaClasses = 'alert alert--info';
 export default function Details({...props}) {
   return (

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

@@ -0,0 +1,8 @@
+/**
+ * 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" />
+export default function DocBreadcrumbs(): JSX.Element | null;

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

@@ -15,11 +15,10 @@ import Link from '@docusaurus/Link';
 import useBaseUrl from '@docusaurus/useBaseUrl';
 import {translate} from '@docusaurus/Translate';
 import IconHome from '@theme/IconHome';
-import styles from './styles.module.css'; // TODO move to design system folder
-
+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

@@ -11,7 +11,6 @@ import {findFirstCategoryLink, useDocById} from '@docusaurus/theme-common';
 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)}`);
   }