@docusaurus/plugin-content-docs 3.7.0-canary-6197 → 3.7.0-canary-6200

package/lib/client/docsUtils.d.ts

@@ -34,6 +34,11 @@ export declare function findFirstSidebarItemLink(item: PropSidebarItem): string
  * on category index pages.
  */
 export declare function useCurrentSidebarCategory(): PropSidebarItemCategory;
+/**
+ * Gets the category associated with the current location. Should only be used
+ * on category index pages.
+ */
+export declare function useCurrentSidebarSiblings(): PropSidebarItem[];
 /**
  * Checks if a sidebar item should be active, based on the active path.
  */

package/lib/client/docsUtils.js

@@ -91,6 +91,24 @@ export function useCurrentSidebarCategory() {
     }
     return deepestCategory;
 }
+/**
+ * Gets the category associated with the current location. Should only be used
+ * on category index pages.
+ */
+export function useCurrentSidebarSiblings() {
+    const { pathname } = useLocation();
+    const sidebar = useDocsSidebar();
+    if (!sidebar) {
+        throw new Error('Unexpected: cant find current sidebar in context');
+    }
+    const categoryBreadcrumbs = getSidebarBreadcrumbs({
+        sidebarItems: sidebar.items,
+        pathname,
+        onlyCategories: true,
+    });
+    const deepestCategory = categoryBreadcrumbs.slice(-1)[0];
+    return deepestCategory?.items ?? sidebar.items;
+}
 const isActive = (testedPath, activePath) => typeof testedPath !== 'undefined' && isSamePath(testedPath, activePath);
 const containsActiveSidebarItem = (items, activePath) => items.some((subItem) => isActiveSidebarItem(subItem, activePath));
 /**

package/lib/client/index.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { UseDataOptions } from '@docusaurus/types';
-export { useDocById, findSidebarCategory, findFirstSidebarItemLink, isActiveSidebarItem, isVisibleSidebarItem, useVisibleSidebarItems, useSidebarBreadcrumbs, useDocsVersionCandidates, useLayoutDoc, useLayoutDocsSidebar, useDocRootMetadata, useCurrentSidebarCategory, filterDocCardListItems, } from './docsUtils';
+export { useDocById, findSidebarCategory, findFirstSidebarItemLink, isActiveSidebarItem, isVisibleSidebarItem, useVisibleSidebarItems, useSidebarBreadcrumbs, useDocsVersionCandidates, useLayoutDoc, useLayoutDocsSidebar, useDocRootMetadata, useCurrentSidebarCategory, useCurrentSidebarSiblings, filterDocCardListItems, } from './docsUtils';
 export { useDocsPreferredVersion } from './docsPreferredVersion';
 export { DocSidebarItemsExpandedStateProvider, useDocSidebarItemsExpandedState, } from './docSidebarItemsExpandedState';
 export { DocsVersionProvider, useDocsVersion } from './docsVersion';

package/lib/client/index.js

@@ -7,7 +7,7 @@
 import { useLocation } from '@docusaurus/router';
 import { useAllPluginInstancesData, usePluginData, } from '@docusaurus/useGlobalData';
 import { getActivePlugin, getLatestVersion, getActiveVersion, getActiveDocContext, getDocVersionSuggestions, } from './docsClientUtils';
-export { useDocById, findSidebarCategory, findFirstSidebarItemLink, isActiveSidebarItem, isVisibleSidebarItem, useVisibleSidebarItems, useSidebarBreadcrumbs, useDocsVersionCandidates, useLayoutDoc, useLayoutDocsSidebar, useDocRootMetadata, useCurrentSidebarCategory, filterDocCardListItems, } from './docsUtils';
+export { useDocById, findSidebarCategory, findFirstSidebarItemLink, isActiveSidebarItem, isVisibleSidebarItem, useVisibleSidebarItems, useSidebarBreadcrumbs, useDocsVersionCandidates, useLayoutDoc, useLayoutDocsSidebar, useDocRootMetadata, useCurrentSidebarCategory, useCurrentSidebarSiblings, filterDocCardListItems, } from './docsUtils';
 export { useDocsPreferredVersion } from './docsPreferredVersion';
 export { DocSidebarItemsExpandedStateProvider, useDocSidebarItemsExpandedState, } from './docSidebarItemsExpandedState';
 export { DocsVersionProvider, useDocsVersion } from './docsVersion';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-docs",
-  "version": "3.7.0-canary-6197",
+  "version": "3.7.0-canary-6200",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "sideEffects": false,
@@ -35,15 +35,15 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "3.7.0-canary-6197",
-    "@docusaurus/logger": "3.7.0-canary-6197",
-    "@docusaurus/mdx-loader": "3.7.0-canary-6197",
-    "@docusaurus/module-type-aliases": "3.7.0-canary-6197",
-    "@docusaurus/theme-common": "3.7.0-canary-6197",
-    "@docusaurus/types": "3.7.0-canary-6197",
-    "@docusaurus/utils": "3.7.0-canary-6197",
-    "@docusaurus/utils-common": "3.7.0-canary-6197",
-    "@docusaurus/utils-validation": "3.7.0-canary-6197",
+    "@docusaurus/core": "3.7.0-canary-6200",
+    "@docusaurus/logger": "3.7.0-canary-6200",
+    "@docusaurus/mdx-loader": "3.7.0-canary-6200",
+    "@docusaurus/module-type-aliases": "3.7.0-canary-6200",
+    "@docusaurus/theme-common": "3.7.0-canary-6200",
+    "@docusaurus/types": "3.7.0-canary-6200",
+    "@docusaurus/utils": "3.7.0-canary-6200",
+    "@docusaurus/utils-common": "3.7.0-canary-6200",
+    "@docusaurus/utils-validation": "3.7.0-canary-6200",
     "@types/react-router-config": "^5.0.7",
     "combine-promises": "^1.1.0",
     "fs-extra": "^11.1.1",
@@ -67,5 +67,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "bf317203dc254101b1ba4c196e4889f4f80f9301"
+  "gitHead": "0fcaaf4f7747ba0367cf5474089365fd0ec0455f"
 }

package/src/client/docsUtils.tsx

@@ -132,6 +132,25 @@ export function useCurrentSidebarCategory(): PropSidebarItemCategory {
   return deepestCategory;
 }
 
+/**
+ * Gets the category associated with the current location. Should only be used
+ * on category index pages.
+ */
+export function useCurrentSidebarSiblings(): PropSidebarItem[] {
+  const {pathname} = useLocation();
+  const sidebar = useDocsSidebar();
+  if (!sidebar) {
+    throw new Error('Unexpected: cant find current sidebar in context');
+  }
+  const categoryBreadcrumbs = getSidebarBreadcrumbs({
+    sidebarItems: sidebar.items,
+    pathname,
+    onlyCategories: true,
+  });
+  const deepestCategory = categoryBreadcrumbs.slice(-1)[0];
+  return deepestCategory?.items ?? sidebar.items;
+}
+
 const isActive = (testedPath: string | undefined, activePath: string) =>
   typeof testedPath !== 'undefined' && isSamePath(testedPath, activePath);
 const containsActiveSidebarItem = (

package/src/client/index.ts

@@ -33,6 +33,7 @@ export {
   useLayoutDocsSidebar,
   useDocRootMetadata,
   useCurrentSidebarCategory,
+  useCurrentSidebarSiblings,
   filterDocCardListItems,
 } from './docsUtils';