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

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

@@ -7,15 +7,13 @@
 import React from 'react';
 import clsx from 'clsx';
 import BlogPostAuthor from '@theme/BlogPostAuthor';
-import styles from './styles.module.css'; // Component responsible for the authors layout
-
+import styles from './styles.module.css';
+// Component responsible for the authors layout
 export default function BlogPostAuthors({authors, assets}) {
   const authorsCount = authors.length;
-
   if (authorsCount === 0) {
     return null;
   }
-
   const imageOnly = authors.every(({name}) => !name);
   return (
     <div

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

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

@@ -13,10 +13,10 @@ import {usePluralForm} from '@docusaurus/theme-common';
 import {blogPostContainerID} from '@docusaurus/utils-common';
 import MDXContent from '@theme/MDXContent';
 import EditThisPage from '@theme/EditThisPage';
-import styles from './styles.module.css';
 import TagsListInline from '@theme/TagsListInline';
-import BlogPostAuthors from '@theme/BlogPostAuthors'; // Very simple pluralization: probably good enough for now
-
+import BlogPostAuthors from '@theme/BlogPostAuthors';
+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

@@ -5,17 +5,16 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React from 'react';
-import BlogLayout from '@theme/BlogLayout';
-import BlogPostItem from '@theme/BlogPostItem';
-import BlogPostPaginator from '@theme/BlogPostPaginator';
+import clsx from 'clsx';
 import {
   PageMetadata,
   HtmlClassNameProvider,
   ThemeClassNames,
 } from '@docusaurus/theme-common';
+import BlogLayout from '@theme/BlogLayout';
+import BlogPostItem from '@theme/BlogPostItem';
+import BlogPostPaginator from '@theme/BlogPostPaginator';
 import TOC from '@theme/TOC';
-import clsx from 'clsx';
-
 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

@@ -5,19 +5,17 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React from 'react';
+import {useWindowSize} from '@docusaurus/theme-common';
 import BlogSidebarDesktop from '@theme/BlogSidebar/Desktop';
 import BlogSidebarMobile from '@theme/BlogSidebar/Mobile';
-import {useWindowSize} from '@docusaurus/theme-common';
 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-next → lib}/theme/BlogTagsListPage/index.js

@@ -5,16 +5,16 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React from 'react';
-import BlogLayout from '@theme/BlogLayout';
-import TagsListByLetter from '@theme/TagsListByLetter';
+import clsx from 'clsx';
 import {
   PageMetadata,
   HtmlClassNameProvider,
   ThemeClassNames,
   translateTagsPageTitle,
 } from '@docusaurus/theme-common';
+import BlogLayout from '@theme/BlogLayout';
+import TagsListByLetter from '@theme/TagsListByLetter';
 import SearchMetadata from '../SearchMetadata';
-import clsx from 'clsx';
 export default function BlogTagsListPage({tags, sidebar}) {
   const title = translateTagsPageTitle();
   return (

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

@@ -5,9 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React from 'react';
-import Link from '@docusaurus/Link';
-import BlogLayout from '@theme/BlogLayout';
-import BlogPostItem from '@theme/BlogPostItem';
+import clsx from 'clsx';
 import Translate, {translate} from '@docusaurus/Translate';
 import {
   PageMetadata,
@@ -15,10 +13,12 @@ import {
   ThemeClassNames,
   usePluralForm,
 } from '@docusaurus/theme-common';
+import Link from '@docusaurus/Link';
+import BlogLayout from '@theme/BlogLayout';
+import BlogPostItem from '@theme/BlogPostItem';
 import BlogListPaginator from '@theme/BlogListPaginator';
 import SearchMetadata from '@theme/SearchMetadata';
-import clsx from 'clsx'; // Very simple pluralization: probably good enough for now
-
+// Very simple pluralization: probably good enough for now
 function useBlogPostsPlural() {
   const {selectMessage} = usePluralForm();
   return (count) =>
@@ -31,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(
@@ -46,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

@@ -5,12 +5,12 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React from 'react';
-import Container from '@theme/CodeBlock/Container';
 import clsx from 'clsx';
-import styles from './styles.module.css'; // <pre> tags in markdown map to CodeBlocks. They may contain JSX children. When
+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
 // 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

@@ -5,6 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React from 'react';
+import clsx from 'clsx';
 import {
   useThemeConfig,
   parseCodeBlockTitle,
@@ -14,7 +15,6 @@ import {
   usePrismTheme,
   useCodeWordWrap,
 } from '@docusaurus/theme-common';
-import clsx from 'clsx';
 import Highlight, {defaultProps} from 'prism-react-renderer';
 import Line from '@theme/CodeBlock/Line';
 import CopyButton from '@theme/CodeBlock/CopyButton';
@@ -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,
@@ -46,7 +46,7 @@ export default function CodeBlockString({
     magicComments,
   });
   const showLineNumbers =
-    showLineNumbersProp || containsLineNumbers(metastring);
+    showLineNumbersProp ?? containsLineNumbers(metastring);
   return (
     <Container
       as="div"

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

@@ -14,15 +14,13 @@ import StringContent from '@theme/CodeBlock/Content/String';
  * return `children` as-is; otherwise, it concatenates the string children
  * together.
  */
-
 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

@@ -5,13 +5,12 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React from 'react';
+import clsx from 'clsx';
 import useIsBrowser from '@docusaurus/useIsBrowser';
 import {translate} from '@docusaurus/Translate';
 import IconLightMode from '@theme/IconLightMode';
 import IconDarkMode from '@theme/IconDarkMode';
-import clsx from 'clsx';
 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;