@docusaurus/theme-classic 3.4.0 → 3.5.0

package/src/theme/NavbarItem/DocsVersionDropdownNavbarItem.tsx

@@ -9,18 +9,36 @@ import React from 'react';
 import {
   useVersions,
   useActiveDocContext,
+  useDocsVersionCandidates,
+  useDocsPreferredVersion,
 } from '@docusaurus/plugin-content-docs/client';
-import {useDocsPreferredVersion} from '@docusaurus/theme-common';
-import {useDocsVersionCandidates} from '@docusaurus/theme-common/internal';
 import {translate} from '@docusaurus/Translate';
 import {useLocation} from '@docusaurus/router';
 import DefaultNavbarItem from '@theme/NavbarItem/DefaultNavbarItem';
 import DropdownNavbarItem from '@theme/NavbarItem/DropdownNavbarItem';
 import type {Props} from '@theme/NavbarItem/DocsVersionDropdownNavbarItem';
-import type {GlobalVersion} from '@docusaurus/plugin-content-docs/client';
+import type {LinkLikeNavbarItemProps} from '@theme/NavbarItem';
+import type {
+  GlobalVersion,
+  GlobalDoc,
+  ActiveDocContext,
+} from '@docusaurus/plugin-content-docs/client';
 
-const getVersionMainDoc = (version: GlobalVersion) =>
-  version.docs.find((doc) => doc.id === version.mainDocId)!;
+function getVersionMainDoc(version: GlobalVersion): GlobalDoc {
+  return version.docs.find((doc) => doc.id === version.mainDocId)!;
+}
+
+function getVersionTargetDoc(
+  version: GlobalVersion,
+  activeDocContext: ActiveDocContext,
+): GlobalDoc {
+  // We try to link to the same doc, in another version
+  // When not possible, fallback to the "main doc" of the version
+  return (
+    activeDocContext.alternateDocVersions[version.name] ??
+    getVersionMainDoc(version)
+  );
+}
 
 export default function DocsVersionDropdownNavbarItem({
   mobile,
@@ -34,23 +52,21 @@ export default function DocsVersionDropdownNavbarItem({
   const activeDocContext = useActiveDocContext(docsPluginId);
   const versions = useVersions(docsPluginId);
   const {savePreferredVersionName} = useDocsPreferredVersion(docsPluginId);
-  const versionLinks = versions.map((version) => {
-    // We try to link to the same doc, in another version
-    // When not possible, fallback to the "main doc" of the version
-    const versionDoc =
-      activeDocContext.alternateDocVersions[version.name] ??
-      getVersionMainDoc(version);
+
+  function versionToLink(version: GlobalVersion): LinkLikeNavbarItemProps {
+    const targetDoc = getVersionTargetDoc(version, activeDocContext);
     return {
       label: version.label,
       // preserve ?search#hash suffix on version switches
-      to: `${versionDoc.path}${search}${hash}`,
+      to: `${targetDoc.path}${search}${hash}`,
       isActive: () => version === activeDocContext.activeVersion,
       onClick: () => savePreferredVersionName(version.name),
     };
-  });
-  const items = [
+  }
+
+  const items: LinkLikeNavbarItemProps[] = [
     ...dropdownItemsBefore,
-    ...versionLinks,
+    ...versions.map(versionToLink),
     ...dropdownItemsAfter,
   ];
 
@@ -69,7 +85,7 @@ export default function DocsVersionDropdownNavbarItem({
   const dropdownTo =
     mobile && items.length > 1
       ? undefined
-      : getVersionMainDoc(dropdownVersion).path;
+      : getVersionTargetDoc(dropdownVersion, activeDocContext).path;
 
   // We don't want to render a version dropdown with 0 or 1 item. If we build
   // the site with a single docs version (onlyIncludeVersions: ['1.0.0']),

package/src/theme/NavbarItem/DocsVersionNavbarItem.tsx

@@ -6,7 +6,7 @@
  */
 
 import React from 'react';
-import {useDocsVersionCandidates} from '@docusaurus/theme-common/internal';
+import {useDocsVersionCandidates} from '@docusaurus/plugin-content-docs/client';
 import DefaultNavbarItem from '@theme/NavbarItem/DefaultNavbarItem';
 import type {Props} from '@theme/NavbarItem/DocsVersionNavbarItem';
 import type {GlobalVersion} from '@docusaurus/plugin-content-docs/client';

package/src/theme/Tabs/index.tsx

@@ -122,7 +122,9 @@ function TabContent({
       // fail-safe or fail-fast? not sure what's best here
       return null;
     }
-    return cloneElement(selectedTabItem, {className: 'margin-top--md'});
+    return cloneElement(selectedTabItem, {
+      className: clsx('margin-top--md', selectedTabItem.props.className),
+    });
   }
   return (
     <div className="margin-top--md">

package/src/theme-classic.d.ts

@@ -185,6 +185,30 @@ declare module '@theme/BackToTopButton' {
   export default function BackToTopButton(): JSX.Element;
 }
 
+declare module '@theme/Blog/Components/Author' {
+  import type {Author} from '@docusaurus/plugin-content-blog';
+
+  export interface Props {
+    readonly as?: 'h1' | 'h2';
+    readonly author: Author;
+    readonly className?: string;
+    readonly count?: number;
+  }
+
+  export default function BlogAuthor(props: Props): JSX.Element;
+}
+
+declare module '@theme/Blog/Components/Author/Socials' {
+  import type {Author} from '@docusaurus/plugin-content-blog';
+
+  export interface Props {
+    readonly author: Author;
+    readonly className?: string;
+  }
+
+  export default function BlogAuthorSocials(props: Props): JSX.Element;
+}
+
 declare module '@theme/BlogListPaginator' {
   import type {BlogPaginatedMetadata} from '@docusaurus/plugin-content-blog';
 
@@ -194,6 +218,19 @@ declare module '@theme/BlogListPaginator' {
   export default function BlogListPaginator(props: Props): JSX.Element;
 }
 
+declare module '@theme/BlogSidebar/Content' {
+  import type {ReactNode, ComponentType} from 'react';
+  import type {BlogSidebarItem} from '@docusaurus/plugin-content-blog';
+
+  export interface Props {
+    readonly items: BlogSidebarItem[];
+    readonly ListComponent: ComponentType<{items: BlogSidebarItem[]}>;
+    readonly yearGroupHeadingClassName?: string;
+  }
+
+  export default function BlogSidebarContent(props: Props): ReactNode;
+}
+
 declare module '@theme/BlogSidebar/Desktop' {
   import type {BlogSidebar} from '@docusaurus/plugin-content-blog';
 
@@ -278,17 +315,6 @@ declare module '@theme/BlogPostItem/Header/Info' {
   export default function BlogPostItemHeaderInfo(): JSX.Element;
 }
 
-declare module '@theme/BlogPostItem/Header/Author' {
-  import type {PropBlogPostContent} from '@docusaurus/plugin-content-blog';
-
-  export interface Props {
-    readonly author: PropBlogPostContent['metadata']['authors'][number];
-    readonly className?: string;
-  }
-
-  export default function BlogPostItemHeaderAuthor(props: Props): JSX.Element;
-}
-
 declare module '@theme/BlogPostItem/Header/Authors' {
   export interface Props {
     readonly className?: string;
@@ -1501,6 +1527,54 @@ declare module '@theme/Icon/WordWrap' {
   export default function IconWordWrap(props: Props): JSX.Element;
 }
 
+declare module '@theme/Icon/Socials/Twitter' {
+  import type {ComponentProps} from 'react';
+
+  export interface Props extends ComponentProps<'svg'> {}
+
+  export default function Twitter(props: Props): JSX.Element;
+}
+
+declare module '@theme/Icon/Socials/GitHub' {
+  import type {ComponentProps} from 'react';
+
+  export interface Props extends ComponentProps<'svg'> {}
+
+  export default function Github(props: Props): JSX.Element;
+}
+
+declare module '@theme/Icon/Socials/X' {
+  import type {ComponentProps} from 'react';
+
+  export interface Props extends ComponentProps<'svg'> {}
+
+  export default function X(props: Props): JSX.Element;
+}
+
+declare module '@theme/Icon/Socials/LinkedIn' {
+  import type {ComponentProps} from 'react';
+
+  export interface Props extends ComponentProps<'svg'> {}
+
+  export default function LinkedIn(props: Props): JSX.Element;
+}
+
+declare module '@theme/Icon/Socials/Default' {
+  import type {ComponentProps} from 'react';
+
+  export interface Props extends ComponentProps<'svg'> {}
+
+  export default function DefaultSocialIcon(props: Props): JSX.Element;
+}
+
+declare module '@theme/Icon/Socials/StackOverflow' {
+  import type {ComponentProps} from 'react';
+
+  export interface Props extends ComponentProps<'svg'> {}
+
+  export default function StackOverflow(props: Props): JSX.Element;
+}
+
 declare module '@theme/TagsListByLetter' {
   import type {TagsListItem} from '@docusaurus/utils';
 
@@ -1528,7 +1602,19 @@ declare module '@theme/Tag' {
   export default function Tag(props: Props): JSX.Element;
 }
 
-declare module '@theme/Unlisted' {
+declare module '@theme/ContentVisibility' {
+  export interface Props {
+    readonly metadata: {
+      // the visibility metadata our 3 content plugins share in common
+      readonly unlisted: boolean;
+      readonly frontMatter: {draft?: boolean; unlisted?: boolean};
+    };
+  }
+
+  export default function ContentVisibility(props: Props): JSX.Element;
+}
+
+declare module '@theme/ContentVisibility/Unlisted' {
   export interface Props {
     className?: string;
   }
@@ -1536,6 +1622,14 @@ declare module '@theme/Unlisted' {
   export default function Unlisted(props: Props): JSX.Element;
 }
 
+declare module '@theme/ContentVisibility/Draft' {
+  export interface Props {
+    className?: string;
+  }
+
+  export default function Draft(props: Props): JSX.Element;
+}
+
 declare module '@theme/prism-include-languages' {
   import type * as PrismNamespace from 'prismjs';
 

package/lib/theme/BlogPostItem/Header/Author/index.d.ts

@@ -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.
- */
-/// <reference path="../../../../../src/theme-classic.d.ts" />
-/// <reference types="react" />
-import type { Props } from '@theme/BlogPostItem/Header/Author';
-export default function BlogPostItemHeaderAuthor({ author, className, }: Props): JSX.Element;

package/lib/theme/BlogPostItem/Header/Author/index.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 React from 'react';
-import clsx from 'clsx';
-import Link from '@docusaurus/Link';
-function MaybeLink(props) {
-  if (props.href) {
-    return <Link {...props} />;
-  }
-  return <>{props.children}</>;
-}
-export default function BlogPostItemHeaderAuthor({author, className}) {
-  const {name, title, url, imageURL, email} = author;
-  const link = url || (email && `mailto:${email}`) || undefined;
-  return (
-    <div className={clsx('avatar margin-bottom--sm', className)}>
-      {imageURL && (
-        <MaybeLink href={link} className="avatar__photo-link">
-          <img className="avatar__photo" src={imageURL} alt={name} />
-        </MaybeLink>
-      )}
-
-      {name && (
-        <div className="avatar__intro">
-          <div className="avatar__name">
-            <MaybeLink href={link}>
-              <span>{name}</span>
-            </MaybeLink>
-          </div>
-          {title && <small className="avatar__subtitle">{title}</small>}
-        </div>
-      )}
-    </div>
-  );
-}

package/src/theme/BlogPostItem/Header/Author/index.tsx

@@ -1,47 +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 from 'react';
-import clsx from 'clsx';
-import Link, {type Props as LinkProps} from '@docusaurus/Link';
-
-import type {Props} from '@theme/BlogPostItem/Header/Author';
-
-function MaybeLink(props: LinkProps): JSX.Element {
-  if (props.href) {
-    return <Link {...props} />;
-  }
-  return <>{props.children}</>;
-}
-
-export default function BlogPostItemHeaderAuthor({
-  author,
-  className,
-}: Props): JSX.Element {
-  const {name, title, url, imageURL, email} = author;
-  const link = url || (email && `mailto:${email}`) || undefined;
-  return (
-    <div className={clsx('avatar margin-bottom--sm', className)}>
-      {imageURL && (
-        <MaybeLink href={link} className="avatar__photo-link">
-          <img className="avatar__photo" src={imageURL} alt={name} />
-        </MaybeLink>
-      )}
-
-      {name && (
-        <div className="avatar__intro">
-          <div className="avatar__name">
-            <MaybeLink href={link}>
-              <span>{name}</span>
-            </MaybeLink>
-          </div>
-          {title && <small className="avatar__subtitle">{title}</small>}
-        </div>
-      )}
-    </div>
-  );
-}