fix(docs): fix sidebar item visibility bug for category index (facebo…

…ok#10754)
weixiabing · Dec 10, 2024 · 91c0b5b · 91c0b5b
1 parent 4966dce
commit 91c0b5b
Show file tree

Hide file tree

Showing 6 changed files with 50 additions and 1 deletion.
diff --git a/packages/docusaurus-plugin-content-docs/src/client/__tests__/docsUtils.test.tsx b/packages/docusaurus-plugin-content-docs/src/client/__tests__/docsUtils.test.tsx
@@ -440,6 +440,7 @@ describe('isVisibleSidebarItem', () => {
   it('works with category', () => {
     const subCategoryAllUnlisted = testCategory({
       href: '/sub-category-path',
+      linkUnlisted: true,
       items: [
         {
           type: 'link',
@@ -455,6 +456,7 @@ describe('isVisibleSidebarItem', () => {
         },
         testCategory({
           href: '/sub-sub-category-path',
+          linkUnlisted: true,
           items: [
             {
               type: 'link',
@@ -500,6 +502,22 @@ describe('isVisibleSidebarItem', () => {
     expect(
       isVisibleSidebarItem(categorySomeUnlisted, categorySomeUnlisted.href!),
     ).toBe(true);
+
+    const categoryOnlyIndexListed = testCategory({
+      href: '/category-only-index-listed',
+      items: [
+        {
+          type: 'link',
+          href: '/sub-link-path',
+          label: 'Label',
+          unlisted: true,
+        },
+        subCategoryAllUnlisted,
+      ],
+    });
+    expect(
+      isVisibleSidebarItem(categoryOnlyIndexListed, '/nonexistentPath'),
+    ).toBe(true);
   });
 });
 

diff --git a/packages/docusaurus-plugin-content-docs/src/client/docsUtils.tsx b/packages/docusaurus-plugin-content-docs/src/client/docsUtils.tsx
@@ -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':

diff --git a/...s tests/tests/visibility/some-unlisteds/subcategory-with-listed-index/index.mdx b/...s tests/tests/visibility/some-unlisteds/subcategory-with-listed-index/index.mdx
@@ -0,0 +1,14 @@
+---
+unlisted: false
+tags: [visibility, unlisted]
+---
+
+# Subcategory index listed
+
+Doc index, **listed**, but all the other category items are unlisted
+
+```mdx-code-block
+import DocCardList from '@theme/DocCardList';
+
+<DocCardList />
+```
diff --git a/...sts/tests/visibility/some-unlisteds/subcategory-with-listed-index/unlisted1.mdx b/...sts/tests/visibility/some-unlisteds/subcategory-with-listed-index/unlisted1.mdx
@@ -0,0 +1,8 @@
+---
+unlisted: true
+tags: [visibility, unlisted]
+---
+
+# Unlisted 1
+
+Doc with unlisted front matter
diff --git a/...sts/tests/visibility/some-unlisteds/subcategory-with-listed-index/unlisted2.mdx b/...sts/tests/visibility/some-unlisteds/subcategory-with-listed-index/unlisted2.mdx
@@ -0,0 +1,8 @@
+---
+unlisted: true
+tags: [visibility, unlisted]
+---
+
+# Unlisted 2
+
+Doc with unlisted front matter
diff --git a/...ding/_docs tests/tests/visibility/some-unlisteds/unlisted-subcategory/index.mdx b/...ding/_docs tests/tests/visibility/some-unlisteds/unlisted-subcategory/index.mdx
@@ -3,7 +3,7 @@ unlisted: true
 tags: [visibility, unlisted]
 ---
 
-# Some Unlisteds - Subcategory index unlisted
+# Subcategory index unlisted
 
 Doc with unlisted front matter