@docusaurus/theme-classic 3.8.1-canary-6384 → 3.8.1-canary-6386

package/lib/theme/DocSidebarItem/Category/index.d.ts

@@ -6,4 +6,4 @@
  */
 import { type ReactNode } from 'react';
 import type { Props } from '@theme/DocSidebarItem/Category';
-export default function DocSidebarItemCategory({ item, onItemClick, activePath, level, index, ...props }: Props): ReactNode;
+export default function DocSidebarItemCategory(props: Props): ReactNode;

package/lib/theme/DocSidebarItem/Category/index.js

@@ -18,11 +18,13 @@ import {
   isActiveSidebarItem,
   findFirstSidebarItemLink,
   useDocSidebarItemsExpandedState,
+  useVisibleSidebarItems,
 } from '@docusaurus/plugin-content-docs/client';
 import Link from '@docusaurus/Link';
 import {translate} from '@docusaurus/Translate';
 import useIsBrowser from '@docusaurus/useIsBrowser';
 import DocSidebarItems from '@theme/DocSidebarItems';
+import DocSidebarItemLink from '@theme/DocSidebarItem/Link';
 import styles from './styles.module.css';
 // If we navigate to a category and it becomes active, it should automatically
 // expand itself
@@ -108,7 +110,43 @@ function CategoryLinkLabel({label}) {
     </span>
   );
 }
-export default function DocSidebarItemCategory({
+export default function DocSidebarItemCategory(props) {
+  const visibleChildren = useVisibleSidebarItems(
+    props.item.items,
+    props.activePath,
+  );
+  if (visibleChildren.length === 0) {
+    return <DocSidebarItemCategoryEmpty {...props} />;
+  } else {
+    return <DocSidebarItemCategoryCollapsible {...props} />;
+  }
+}
+function isCategoryWithHref(category) {
+  return typeof category.href === 'string';
+}
+// If a category doesn't have any visible children, we render it as a link
+function DocSidebarItemCategoryEmpty({item, ...props}) {
+  // If the category has no link, we don't render anything
+  // It's not super useful to render a category you can't open nor click
+  if (!isCategoryWithHref(item)) {
+    return null;
+  }
+  // We remove props that don't make sense for a link and forward the rest
+  const {
+    type,
+    collapsed,
+    collapsible,
+    items,
+    linkUnlisted,
+    ...forwardableProps
+  } = item;
+  const linkItem = {
+    type: 'link',
+    ...forwardableProps,
+  };
+  return <DocSidebarItemLink item={linkItem} {...props} />;
+}
+function DocSidebarItemCategoryCollapsible({
   item,
   onItemClick,
   activePath,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/theme-classic",
-  "version": "3.8.1-canary-6384",
+  "version": "3.8.1-canary-6386",
   "description": "Classic theme for Docusaurus",
   "main": "lib/index.js",
   "types": "src/theme-classic.d.ts",
@@ -20,19 +20,19 @@
     "copy:watch": "node ../../admin/scripts/copyUntypedFiles.js --watch"
   },
   "dependencies": {
-    "@docusaurus/core": "3.8.1-canary-6384",
-    "@docusaurus/logger": "3.8.1-canary-6384",
-    "@docusaurus/mdx-loader": "3.8.1-canary-6384",
-    "@docusaurus/module-type-aliases": "3.8.1-canary-6384",
-    "@docusaurus/plugin-content-blog": "3.8.1-canary-6384",
-    "@docusaurus/plugin-content-docs": "3.8.1-canary-6384",
-    "@docusaurus/plugin-content-pages": "3.8.1-canary-6384",
-    "@docusaurus/theme-common": "3.8.1-canary-6384",
-    "@docusaurus/theme-translations": "3.8.1-canary-6384",
-    "@docusaurus/types": "3.8.1-canary-6384",
-    "@docusaurus/utils": "3.8.1-canary-6384",
-    "@docusaurus/utils-common": "3.8.1-canary-6384",
-    "@docusaurus/utils-validation": "3.8.1-canary-6384",
+    "@docusaurus/core": "3.8.1-canary-6386",
+    "@docusaurus/logger": "3.8.1-canary-6386",
+    "@docusaurus/mdx-loader": "3.8.1-canary-6386",
+    "@docusaurus/module-type-aliases": "3.8.1-canary-6386",
+    "@docusaurus/plugin-content-blog": "3.8.1-canary-6386",
+    "@docusaurus/plugin-content-docs": "3.8.1-canary-6386",
+    "@docusaurus/plugin-content-pages": "3.8.1-canary-6386",
+    "@docusaurus/theme-common": "3.8.1-canary-6386",
+    "@docusaurus/theme-translations": "3.8.1-canary-6386",
+    "@docusaurus/types": "3.8.1-canary-6386",
+    "@docusaurus/utils": "3.8.1-canary-6386",
+    "@docusaurus/utils-common": "3.8.1-canary-6386",
+    "@docusaurus/utils-validation": "3.8.1-canary-6386",
     "@mdx-js/react": "^3.0.0",
     "clsx": "^2.0.0",
     "copy-text-to-clipboard": "^3.2.0",
@@ -62,5 +62,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "1f293331ed8aeb0d81fd0856b88b4329cc263dda"
+  "gitHead": "588d7e70cceaaaaf7218b0834ee3623e5aa1fe0b"
 }

package/src/theme/DocSidebarItem/Category/index.tsx

@@ -24,13 +24,19 @@ import {
   isActiveSidebarItem,
   findFirstSidebarItemLink,
   useDocSidebarItemsExpandedState,
+  useVisibleSidebarItems,
 } from '@docusaurus/plugin-content-docs/client';
 import Link from '@docusaurus/Link';
 import {translate} from '@docusaurus/Translate';
 import useIsBrowser from '@docusaurus/useIsBrowser';
 import DocSidebarItems from '@theme/DocSidebarItems';
+import DocSidebarItemLink from '@theme/DocSidebarItem/Link';
 import type {Props} from '@theme/DocSidebarItem/Category';
 
+import type {
+  PropSidebarItemCategory,
+  PropSidebarItemLink,
+} from '@docusaurus/plugin-content-docs';
 import styles from './styles.module.css';
 
 // If we navigate to a category and it becomes active, it should automatically
@@ -136,7 +142,48 @@ function CategoryLinkLabel({label}: {label: string}) {
   );
 }
 
-export default function DocSidebarItemCategory({
+export default function DocSidebarItemCategory(props: Props): ReactNode {
+  const visibleChildren = useVisibleSidebarItems(
+    props.item.items,
+    props.activePath,
+  );
+  if (visibleChildren.length === 0) {
+    return <DocSidebarItemCategoryEmpty {...props} />;
+  } else {
+    return <DocSidebarItemCategoryCollapsible {...props} />;
+  }
+}
+
+function isCategoryWithHref(
+  category: PropSidebarItemCategory,
+): category is PropSidebarItemCategory & {href: string} {
+  return typeof category.href === 'string';
+}
+
+// If a category doesn't have any visible children, we render it as a link
+function DocSidebarItemCategoryEmpty({item, ...props}: Props): ReactNode {
+  // If the category has no link, we don't render anything
+  // It's not super useful to render a category you can't open nor click
+  if (!isCategoryWithHref(item)) {
+    return null;
+  }
+  // We remove props that don't make sense for a link and forward the rest
+  const {
+    type,
+    collapsed,
+    collapsible,
+    items,
+    linkUnlisted,
+    ...forwardableProps
+  } = item;
+  const linkItem: PropSidebarItemLink = {
+    type: 'link',
+    ...forwardableProps,
+  };
+  return <DocSidebarItemLink item={linkItem} {...props} />;
+}
+
+function DocSidebarItemCategoryCollapsible({
   item,
   onItemClick,
   activePath,