@docusaurus/plugin-content-docs 3.6.3 → 3.7.0

package/lib/client/doc.d.ts

@@ -18,7 +18,7 @@ export type DocContextValue = Pick<PropDocContent, 'metadata' | 'frontMatter' |
 export declare function DocProvider({ children, content, }: {
     children: ReactNode;
     content: PropDocContent;
-}): JSX.Element;
+}): ReactNode;
 /**
  * Returns the data of the currently browsed doc. Gives access to the doc's MDX
  * Component, front matter, metadata, TOC, etc. When swizzling a low-level

package/lib/client/docSidebarItemsExpandedState.d.ts

@@ -25,6 +25,6 @@ type ContextValue = {
  */
 export declare function DocSidebarItemsExpandedStateProvider({ children, }: {
     children: ReactNode;
-}): JSX.Element;
+}): ReactNode;
 export declare function useDocSidebarItemsExpandedState(): ContextValue;
 export {};

package/lib/client/docsPreferredVersion.d.ts

@@ -12,7 +12,7 @@ import { type GlobalVersion } from '@docusaurus/plugin-content-docs/client';
  */
 export declare function DocsPreferredVersionContextProvider({ children, }: {
     children: ReactNode;
-}): JSX.Element;
+}): ReactNode;
 /**
  * Returns a read-write interface to a plugin's preferred version. The
  * "preferred version" is defined as the last version that the user visited.

package/lib/client/docsSidebar.d.ts

@@ -17,7 +17,7 @@ export declare function DocsSidebarProvider({ children, name, items, }: {
     children: ReactNode;
     name: string | undefined;
     items: PropSidebar | undefined;
-}): JSX.Element;
+}): ReactNode;
 /**
  * Gets the sidebar that's currently displayed, or `null` if there isn't one
  */

package/lib/client/docsUtils.d.ts

@@ -4,6 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
+import { type ReactNode } from 'react';
 import { type GlobalVersion, type GlobalSidebar, type GlobalDoc } from '@docusaurus/plugin-content-docs/client';
 import type { Props as DocRootProps } from '@theme/DocRoot';
 import type { PropSidebar, PropSidebarItem, PropSidebarItemCategory, PropVersionDoc, PropSidebarBreadcrumbsItem } from '@docusaurus/plugin-content-docs';
@@ -90,7 +91,7 @@ export declare function useLayoutDoc(docId: string, docsPluginId?: string): Glob
  */
 export declare function useDocRootMetadata({ route }: DocRootProps): null | {
     /** The element that should be rendered at the current location. */
-    docElement: JSX.Element;
+    docElement: ReactNode;
     /**
      * The name of the sidebar associated with the current doc. `sidebarName` and
      * `sidebarItems` correspond to the value of {@link useDocsSidebar}.

package/lib/client/docsUtils.js

@@ -110,6 +110,7 @@ export function isVisibleSidebarItem(item, activePath) {
     switch (item.type) {
         case 'category':
             return (isActiveSidebarItem(item, activePath) ||
+                (typeof item.href !== 'undefined' && !item.linkUnlisted) ||
                 item.items.some((subItem) => isVisibleSidebarItem(subItem, activePath)));
         case 'link':
             // An unlisted item remains visible if it is active

package/lib/client/docsVersion.d.ts

@@ -12,7 +12,7 @@ import type { PropVersionMetadata } from '@docusaurus/plugin-content-docs';
 export declare function DocsVersionProvider({ children, version, }: {
     children: ReactNode;
     version: PropVersionMetadata | null;
-}): JSX.Element;
+}): ReactNode;
 /**
  * Gets the version metadata of the current doc page.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-docs",
-  "version": "3.6.3",
+  "version": "3.7.0",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "sideEffects": false,
@@ -35,15 +35,15 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "3.6.3",
-    "@docusaurus/logger": "3.6.3",
-    "@docusaurus/mdx-loader": "3.6.3",
-    "@docusaurus/module-type-aliases": "3.6.3",
-    "@docusaurus/theme-common": "3.6.3",
-    "@docusaurus/types": "3.6.3",
-    "@docusaurus/utils": "3.6.3",
-    "@docusaurus/utils-common": "3.6.3",
-    "@docusaurus/utils-validation": "3.6.3",
+    "@docusaurus/core": "3.7.0",
+    "@docusaurus/logger": "3.7.0",
+    "@docusaurus/mdx-loader": "3.7.0",
+    "@docusaurus/module-type-aliases": "3.7.0",
+    "@docusaurus/theme-common": "3.7.0",
+    "@docusaurus/types": "3.7.0",
+    "@docusaurus/utils": "3.7.0",
+    "@docusaurus/utils-common": "3.7.0",
+    "@docusaurus/utils-validation": "3.7.0",
     "@types/react-router-config": "^5.0.7",
     "combine-promises": "^1.1.0",
     "fs-extra": "^11.1.1",
@@ -61,11 +61,11 @@
     "shelljs": "^0.8.5"
   },
   "peerDependencies": {
-    "react": "^18.0.0",
-    "react-dom": "^18.0.0"
+    "react": "^18.0.0 || ^19.0.0",
+    "react-dom": "^18.0.0 || ^19.0.0"
   },
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "9c0e19c669ffcbc0972bfd8527e8b93f1f74e7d8"
+  "gitHead": "dd59750c16fe6908a26f18806a54d4c3dbe6db43"
 }

package/src/client/doc.tsx

@@ -50,7 +50,7 @@ export function DocProvider({
 }: {
   children: ReactNode;
   content: PropDocContent;
-}): JSX.Element {
+}): ReactNode {
   const contextValue = useContextValue(content);
   return <Context.Provider value={contextValue}>{children}</Context.Provider>;
 }

package/src/client/docSidebarItemsExpandedState.tsx

@@ -36,7 +36,7 @@ export function DocSidebarItemsExpandedStateProvider({
   children,
 }: {
   children: ReactNode;
-}): JSX.Element {
+}): ReactNode {
   const [expandedItem, setExpandedItem] = useState<number | null>(null);
   const contextValue = useMemo(
     () => ({expandedItem, setExpandedItem}),

package/src/client/docsPreferredVersion.tsx

@@ -163,7 +163,7 @@ function DocsPreferredVersionContextProviderUnsafe({
   children,
 }: {
   children: ReactNode;
-}): JSX.Element {
+}): ReactNode {
   const value = useContextValue();
   return <Context.Provider value={value}>{children}</Context.Provider>;
 }
@@ -176,7 +176,7 @@ export function DocsPreferredVersionContextProvider({
   children,
 }: {
   children: ReactNode;
-}): JSX.Element {
+}): ReactNode {
   return (
     <DocsPreferredVersionContextProviderUnsafe>
       {children}

package/src/client/docsSidebar.tsx

@@ -30,7 +30,7 @@ export function DocsSidebarProvider({
   children: ReactNode;
   name: string | undefined;
   items: PropSidebar | undefined;
-}): JSX.Element {
+}): ReactNode {
   const stableValue: ContextValue | null = useMemo(
     () => (name && items ? {name, items} : null),
     [name, items],

package/src/client/docsUtils.tsx

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import {useMemo} from 'react';
+import {type ReactNode, useMemo} from 'react';
 import {matchPath, useLocation} from '@docusaurus/router';
 import renderRoutes from '@docusaurus/renderRoutes';
 import {
@@ -168,6 +168,7 @@ export function isVisibleSidebarItem(
     case 'category':
       return (
         isActiveSidebarItem(item, activePath) ||
+        (typeof item.href !== 'undefined' && !item.linkUnlisted) ||
         item.items.some((subItem) => isVisibleSidebarItem(subItem, activePath))
       );
     case 'link':
@@ -363,7 +364,7 @@ Available doc ids are:
  */
 export function useDocRootMetadata({route}: DocRootProps): null | {
   /** The element that should be rendered at the current location. */
-  docElement: JSX.Element;
+  docElement: ReactNode;
   /**
    * The name of the sidebar associated with the current doc. `sidebarName` and
    * `sidebarItems` correspond to the value of {@link useDocsSidebar}.

package/src/client/docsVersion.tsx

@@ -20,7 +20,7 @@ export function DocsVersionProvider({
 }: {
   children: ReactNode;
   version: PropVersionMetadata | null;
-}): JSX.Element {
+}): ReactNode {
   return <Context.Provider value={version}>{children}</Context.Provider>;
 }
 

package/src/plugin-content-docs.d.ts

@@ -562,10 +562,11 @@ declare module '@docusaurus/plugin-content-docs' {
 }
 
 declare module '@theme/DocItem' {
+  import type {ReactNode} from 'react';
   import type {PropDocContent} from '@docusaurus/plugin-content-docs';
 
   export type DocumentRoute = {
-    readonly component: () => JSX.Element;
+    readonly component: () => ReactNode;
     readonly exact: boolean;
     readonly path: string;
     readonly sidebar?: string;
@@ -576,10 +577,11 @@ declare module '@theme/DocItem' {
     readonly content: PropDocContent;
   }
 
-  export default function DocItem(props: Props): JSX.Element;
+  export default function DocItem(props: Props): ReactNode;
 }
 
 declare module '@theme/DocCategoryGeneratedIndexPage' {
+  import type {ReactNode} from 'react';
   import type {PropCategoryGeneratedIndex} from '@docusaurus/plugin-content-docs';
 
   export interface Props {
@@ -588,39 +590,45 @@ declare module '@theme/DocCategoryGeneratedIndexPage' {
 
   export default function DocCategoryGeneratedIndexPage(
     props: Props,
-  ): JSX.Element;
+  ): ReactNode;
 }
 
 declare module '@theme/DocTagsListPage' {
+  import type {ReactNode} from 'react';
   import type {PropTagsListPage} from '@docusaurus/plugin-content-docs';
 
   export interface Props extends PropTagsListPage {}
-  export default function DocTagsListPage(props: Props): JSX.Element;
+  export default function DocTagsListPage(props: Props): ReactNode;
 }
 
 declare module '@theme/DocTagDocListPage' {
+  import type {ReactNode} from 'react';
   import type {PropTagDocList} from '@docusaurus/plugin-content-docs';
 
   export interface Props {
     readonly tag: PropTagDocList;
   }
-  export default function DocTagDocListPage(props: Props): JSX.Element;
+  export default function DocTagDocListPage(props: Props): ReactNode;
 }
 
 declare module '@theme/DocBreadcrumbs' {
-  export default function DocBreadcrumbs(): JSX.Element;
+  import type {ReactNode} from 'react';
+
+  export default function DocBreadcrumbs(): ReactNode;
 }
 
 declare module '@theme/DocsRoot' {
+  import type {ReactNode} from 'react';
   import type {RouteConfigComponentProps} from 'react-router-config';
   import type {Required} from 'utility-types';
 
   export interface Props extends Required<RouteConfigComponentProps, 'route'> {}
 
-  export default function DocsRoot(props: Props): JSX.Element;
+  export default function DocsRoot(props: Props): ReactNode;
 }
 
 declare module '@theme/DocVersionRoot' {
+  import type {ReactNode} from 'react';
   import type {PropVersionMetadata} from '@docusaurus/plugin-content-docs';
   import type {RouteConfigComponentProps} from 'react-router-config';
   import type {Required} from 'utility-types';
@@ -629,14 +637,15 @@ declare module '@theme/DocVersionRoot' {
     readonly version: PropVersionMetadata;
   }
 
-  export default function DocVersionRoot(props: Props): JSX.Element;
+  export default function DocVersionRoot(props: Props): ReactNode;
 }
 
 declare module '@theme/DocRoot' {
+  import type {ReactNode} from 'react';
   import type {RouteConfigComponentProps} from 'react-router-config';
   import type {Required} from 'utility-types';
 
   export interface Props extends Required<RouteConfigComponentProps, 'route'> {}
 
-  export default function DocRoot(props: Props): JSX.Element;
+  export default function DocRoot(props: Props): ReactNode;
 }