@docusaurus/theme-common 2.0.0-rc.1 → 2.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/index.d.ts +1 -1
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +1 -1
- package/lib/index.js.map +1 -1
- package/lib/utils/docsUtils.d.ts +5 -0
- package/lib/utils/docsUtils.d.ts.map +1 -1
- package/lib/utils/docsUtils.js +42 -15
- package/lib/utils/docsUtils.js.map +1 -1
- package/package.json +10 -10
- package/src/index.ts +4 -1
- package/src/utils/docsUtils.tsx +66 -20
package/lib/index.d.ts
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
export { useThemeConfig, type ThemeConfig, type UserThemeConfig, type Navbar, type NavbarItem, type NavbarLogo, type MultiColumnFooter, type SimpleFooter, type Footer, type FooterLogo, type FooterLinkItem, type ColorModeConfig, } from './utils/useThemeConfig';
|
|
8
8
|
export { createStorageSlot, listStorageKeys } from './utils/storageUtils';
|
|
9
9
|
export { useContextualSearchFilters } from './utils/searchUtils';
|
|
10
|
-
export { useCurrentSidebarCategory } from './utils/docsUtils';
|
|
10
|
+
export { useCurrentSidebarCategory, filterDocCardListItems, } from './utils/docsUtils';
|
|
11
11
|
export { usePluralForm } from './utils/usePluralForm';
|
|
12
12
|
export { useCollapsible, Collapsible } from './components/Collapsible';
|
|
13
13
|
export { ThemeClassNames } from './utils/ThemeClassNames';
|
package/lib/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAMH,OAAO,EACL,cAAc,EACd,KAAK,WAAW,EAChB,KAAK,eAAe,EACpB,KAAK,MAAM,EACX,KAAK,UAAU,EACf,KAAK,UAAU,EACf,KAAK,iBAAiB,EACtB,KAAK,YAAY,EACjB,KAAK,MAAM,EACX,KAAK,UAAU,EACf,KAAK,cAAc,EACnB,KAAK,eAAe,GACrB,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAC,iBAAiB,EAAE,eAAe,EAAC,MAAM,sBAAsB,CAAC;AAExE,OAAO,EAAC,0BAA0B,EAAC,MAAM,qBAAqB,CAAC;AAE/D,OAAO,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAMH,OAAO,EACL,cAAc,EACd,KAAK,WAAW,EAChB,KAAK,eAAe,EACpB,KAAK,MAAM,EACX,KAAK,UAAU,EACf,KAAK,UAAU,EACf,KAAK,iBAAiB,EACtB,KAAK,YAAY,EACjB,KAAK,MAAM,EACX,KAAK,UAAU,EACf,KAAK,cAAc,EACnB,KAAK,eAAe,GACrB,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAC,iBAAiB,EAAE,eAAe,EAAC,MAAM,sBAAsB,CAAC;AAExE,OAAO,EAAC,0BAA0B,EAAC,MAAM,qBAAqB,CAAC;AAE/D,OAAO,EACL,yBAAyB,EACzB,sBAAsB,GACvB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC;AAEpD,OAAO,EAAC,cAAc,EAAE,WAAW,EAAC,MAAM,0BAA0B,CAAC;AAErE,OAAO,EAAC,eAAe,EAAC,MAAM,yBAAyB,CAAC;AAExD,OAAO,EACL,yBAAyB,EACzB,QAAQ,EACR,WAAW,EACX,gBAAgB,EAChB,iBAAiB,GAClB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAC,YAAY,EAAE,qBAAqB,EAAC,MAAM,uBAAuB,CAAC;AAE1E,OAAO,EAAC,YAAY,EAAE,KAAK,SAAS,EAAC,MAAM,sBAAsB,CAAC;AAElE,OAAO,EACL,yBAAyB,EACzB,KAAK,4BAA4B,GAClC,MAAM,wCAAwC,CAAC;AAEhD,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC;AAOpD,OAAO,EACL,sBAAsB,EACtB,iBAAiB,EACjB,KAAK,cAAc,GACpB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAC,wBAAwB,EAAC,MAAM,qBAAqB,CAAC;AAE7D,OAAO,EAAC,mBAAmB,EAAC,MAAM,qBAAqB,CAAC;AAExD,OAAO,EAAC,UAAU,EAAE,IAAI,EAAC,MAAM,iBAAiB,CAAC;AAEjD,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC;AAEpD,OAAO,EAAC,uBAAuB,EAAC,MAAM,iCAAiC,CAAC"}
|
package/lib/index.js
CHANGED
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
export { useThemeConfig, } from './utils/useThemeConfig';
|
|
11
11
|
export { createStorageSlot, listStorageKeys } from './utils/storageUtils';
|
|
12
12
|
export { useContextualSearchFilters } from './utils/searchUtils';
|
|
13
|
-
export { useCurrentSidebarCategory } from './utils/docsUtils';
|
|
13
|
+
export { useCurrentSidebarCategory, filterDocCardListItems, } from './utils/docsUtils';
|
|
14
14
|
export { usePluralForm } from './utils/usePluralForm';
|
|
15
15
|
export { useCollapsible, Collapsible } from './components/Collapsible';
|
|
16
16
|
export { ThemeClassNames } from './utils/ThemeClassNames';
|
package/lib/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;GAEG;AAEH,OAAO,EACL,cAAc,GAYf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAC,iBAAiB,EAAE,eAAe,EAAC,MAAM,sBAAsB,CAAC;AAExE,OAAO,EAAC,0BAA0B,EAAC,MAAM,qBAAqB,CAAC;AAE/D,OAAO,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;GAEG;AAEH,OAAO,EACL,cAAc,GAYf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAC,iBAAiB,EAAE,eAAe,EAAC,MAAM,sBAAsB,CAAC;AAExE,OAAO,EAAC,0BAA0B,EAAC,MAAM,qBAAqB,CAAC;AAE/D,OAAO,EACL,yBAAyB,EACzB,sBAAsB,GACvB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC;AAEpD,OAAO,EAAC,cAAc,EAAE,WAAW,EAAC,MAAM,0BAA0B,CAAC;AAErE,OAAO,EAAC,eAAe,EAAC,MAAM,yBAAyB,CAAC;AAExD,OAAO,EACL,yBAAyB,EACzB,QAAQ,EACR,WAAW,EACX,gBAAgB,EAChB,iBAAiB,GAClB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAC,YAAY,EAAE,qBAAqB,EAAC,MAAM,uBAAuB,CAAC;AAE1E,OAAO,EAAC,YAAY,EAAiB,MAAM,sBAAsB,CAAC;AAElE,OAAO,EACL,yBAAyB,GAE1B,MAAM,wCAAwC,CAAC;AAEhD,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC;AAEpD;;;GAGG;AAEH,OAAO,EACL,sBAAsB,EACtB,iBAAiB,GAElB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAC,wBAAwB,EAAC,MAAM,qBAAqB,CAAC;AAE7D,OAAO,EAAC,mBAAmB,EAAC,MAAM,qBAAqB,CAAC;AAExD,OAAO,EAAC,UAAU,EAAE,IAAI,EAAC,MAAM,iBAAiB,CAAC;AAEjD,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC;AAEpD,OAAO,EAAC,uBAAuB,EAAC,MAAM,iCAAiC,CAAC"}
|
package/lib/utils/docsUtils.d.ts
CHANGED
|
@@ -95,4 +95,9 @@ export declare function useDocRouteMetadata({ route, versionMetadata, }: DocPage
|
|
|
95
95
|
/** The items of the sidebar associated with the current doc. */
|
|
96
96
|
sidebarItems: PropSidebar | undefined;
|
|
97
97
|
};
|
|
98
|
+
/**
|
|
99
|
+
* Filter categories that don't have a link.
|
|
100
|
+
* @param items
|
|
101
|
+
*/
|
|
102
|
+
export declare function filterDocCardListItems(items: PropSidebarItem[]): PropSidebarItem[];
|
|
98
103
|
//# sourceMappingURL=docsUtils.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"docsUtils.d.ts","sourceRoot":"","sources":["../../src/utils/docsUtils.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;;AAKH,OAAO,EAKL,KAAK,aAAa,EAClB,KAAK,aAAa,EAClB,KAAK,SAAS,EACf,MAAM,wCAAwC,CAAC;AAChD,OAAO,KAAK,EAAC,KAAK,IAAI,YAAY,EAAC,MAAM,gBAAgB,CAAC;AAM1D,OAAO,KAAK,EACV,WAAW,EACX,eAAe,EACf,uBAAuB,EACvB,cAAc,EACd,0BAA0B,EAC3B,MAAM,iCAAiC,CAAC;AAGzC,eAAO,MAAM,mBAAmB,EAAE,OAA0B,CAAC;AAE7D;;GAEG;AACH,wBAAgB,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,cAAc,CAAC;AACvD;;GAEG;AACH,wBAAgB,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,GAAG,cAAc,GAAG,SAAS,CAAC;AAa/E;;GAEG;AACH,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,WAAW,EACpB,SAAS,EAAE,CAAC,QAAQ,EAAE,uBAAuB,KAAK,OAAO,GACxD,uBAAuB,GAAG,SAAS,CAarC;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CACnC,IAAI,EAAE,uBAAuB,GAC5B,MAAM,GAAG,SAAS,CAiBpB;AAED;;;GAGG;AACH,wBAAgB,yBAAyB,IAAI,uBAAuB,
|
|
1
|
+
{"version":3,"file":"docsUtils.d.ts","sourceRoot":"","sources":["../../src/utils/docsUtils.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;;AAKH,OAAO,EAKL,KAAK,aAAa,EAClB,KAAK,aAAa,EAClB,KAAK,SAAS,EACf,MAAM,wCAAwC,CAAC;AAChD,OAAO,KAAK,EAAC,KAAK,IAAI,YAAY,EAAC,MAAM,gBAAgB,CAAC;AAM1D,OAAO,KAAK,EACV,WAAW,EACX,eAAe,EACf,uBAAuB,EACvB,cAAc,EACd,0BAA0B,EAC3B,MAAM,iCAAiC,CAAC;AAGzC,eAAO,MAAM,mBAAmB,EAAE,OAA0B,CAAC;AAE7D;;GAEG;AACH,wBAAgB,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,cAAc,CAAC;AACvD;;GAEG;AACH,wBAAgB,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,GAAG,cAAc,GAAG,SAAS,CAAC;AAa/E;;GAEG;AACH,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,WAAW,EACpB,SAAS,EAAE,CAAC,QAAQ,EAAE,uBAAuB,KAAK,OAAO,GACxD,uBAAuB,GAAG,SAAS,CAarC;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CACnC,IAAI,EAAE,uBAAuB,GAC5B,MAAM,GAAG,SAAS,CAiBpB;AAED;;;GAGG;AACH,wBAAgB,yBAAyB,IAAI,uBAAuB,CAkBnE;AASD;;GAEG;AACH,wBAAgB,mBAAmB,CACjC,IAAI,EAAE,eAAe,EACrB,UAAU,EAAE,MAAM,GACjB,OAAO,CAaT;AAmDD;;;GAGG;AACH,wBAAgB,qBAAqB,IAAI,0BAA0B,EAAE,GAAG,IAAI,CAQ3E;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,wBAAwB,CACtC,YAAY,CAAC,EAAE,MAAM,GACpB,CAAC,aAAa,EAAE,GAAG,aAAa,EAAE,CAAC,CAWrC;AAED;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAClC,SAAS,EAAE,MAAM,EACjB,YAAY,CAAC,EAAE,MAAM,GACpB,aAAa,CAoBf;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAC1B,KAAK,EAAE,MAAM,EACb,YAAY,CAAC,EAAE,MAAM,GACpB,SAAS,GAAG,IAAI,CAuBlB;AAGD;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CAAC,EAClC,KAAK,EACL,eAAe,GAChB,EAAE,YAAY,GAAG,IAAI,GAAG;IACvB,mEAAmE;IACnE,UAAU,EAAE,GAAG,CAAC,OAAO,CAAC;IACxB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,gEAAgE;IAChE,YAAY,EAAE,WAAW,GAAG,SAAS,CAAC;CACvC,CAwBA;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,eAAe,EAAE,GACvB,eAAe,EAAE,CAOnB"}
|
package/lib/utils/docsUtils.js
CHANGED
|
@@ -75,11 +75,16 @@ export function useCurrentSidebarCategory() {
|
|
|
75
75
|
if (!sidebar) {
|
|
76
76
|
throw new Error('Unexpected: cant find current sidebar in context');
|
|
77
77
|
}
|
|
78
|
-
const
|
|
79
|
-
|
|
78
|
+
const categoryBreadcrumbs = getSidebarBreadcrumbs({
|
|
79
|
+
sidebarItems: sidebar.items,
|
|
80
|
+
pathname,
|
|
81
|
+
onlyCategories: true,
|
|
82
|
+
});
|
|
83
|
+
const deepestCategory = categoryBreadcrumbs.slice(-1)[0];
|
|
84
|
+
if (!deepestCategory) {
|
|
80
85
|
throw new Error(`${pathname} is not associated with a category. useCurrentSidebarCategory() should only be used on category index pages.`);
|
|
81
86
|
}
|
|
82
|
-
return
|
|
87
|
+
return deepestCategory;
|
|
83
88
|
}
|
|
84
89
|
const isActive = (testedPath, activePath) => typeof testedPath !== 'undefined' && isSamePath(testedPath, activePath);
|
|
85
90
|
const containsActiveSidebarItem = (items, activePath) => items.some((subItem) => isActiveSidebarItem(subItem, activePath));
|
|
@@ -97,30 +102,40 @@ export function isActiveSidebarItem(item, activePath) {
|
|
|
97
102
|
return false;
|
|
98
103
|
}
|
|
99
104
|
/**
|
|
100
|
-
*
|
|
101
|
-
*
|
|
105
|
+
* Get the sidebar the breadcrumbs for a given pathname
|
|
106
|
+
* Ordered from top to bottom
|
|
102
107
|
*/
|
|
103
|
-
|
|
104
|
-
const sidebar = useDocsSidebar();
|
|
105
|
-
const { pathname } = useLocation();
|
|
106
|
-
const breadcrumbsOption = useActivePlugin()?.pluginData.breadcrumbs;
|
|
107
|
-
if (breadcrumbsOption === false || !sidebar) {
|
|
108
|
-
return null;
|
|
109
|
-
}
|
|
108
|
+
function getSidebarBreadcrumbs({ sidebarItems, pathname, onlyCategories = false, }) {
|
|
110
109
|
const breadcrumbs = [];
|
|
111
110
|
function extract(items) {
|
|
112
111
|
for (const item of items) {
|
|
113
112
|
if ((item.type === 'category' &&
|
|
114
113
|
(isSamePath(item.href, pathname) || extract(item.items))) ||
|
|
115
114
|
(item.type === 'link' && isSamePath(item.href, pathname))) {
|
|
116
|
-
|
|
115
|
+
const filtered = onlyCategories && item.type !== 'category';
|
|
116
|
+
if (!filtered) {
|
|
117
|
+
breadcrumbs.unshift(item);
|
|
118
|
+
}
|
|
117
119
|
return true;
|
|
118
120
|
}
|
|
119
121
|
}
|
|
120
122
|
return false;
|
|
121
123
|
}
|
|
122
|
-
extract(
|
|
123
|
-
return breadcrumbs
|
|
124
|
+
extract(sidebarItems);
|
|
125
|
+
return breadcrumbs;
|
|
126
|
+
}
|
|
127
|
+
/**
|
|
128
|
+
* Gets the breadcrumbs of the current doc page, based on its sidebar location.
|
|
129
|
+
* Returns `null` if there's no sidebar or breadcrumbs are disabled.
|
|
130
|
+
*/
|
|
131
|
+
export function useSidebarBreadcrumbs() {
|
|
132
|
+
const sidebar = useDocsSidebar();
|
|
133
|
+
const { pathname } = useLocation();
|
|
134
|
+
const breadcrumbsOption = useActivePlugin()?.pluginData.breadcrumbs;
|
|
135
|
+
if (breadcrumbsOption === false || !sidebar) {
|
|
136
|
+
return null;
|
|
137
|
+
}
|
|
138
|
+
return getSidebarBreadcrumbs({ sidebarItems: sidebar.items, pathname });
|
|
124
139
|
}
|
|
125
140
|
/**
|
|
126
141
|
* "Version candidates" are mostly useful for the layout components, which must
|
|
@@ -222,4 +237,16 @@ export function useDocRouteMetadata({ route, versionMetadata, }) {
|
|
|
222
237
|
sidebarItems,
|
|
223
238
|
};
|
|
224
239
|
}
|
|
240
|
+
/**
|
|
241
|
+
* Filter categories that don't have a link.
|
|
242
|
+
* @param items
|
|
243
|
+
*/
|
|
244
|
+
export function filterDocCardListItems(items) {
|
|
245
|
+
return items.filter((item) => {
|
|
246
|
+
if (item.type === 'category') {
|
|
247
|
+
return !!findFirstCategoryLink(item);
|
|
248
|
+
}
|
|
249
|
+
return true;
|
|
250
|
+
});
|
|
251
|
+
}
|
|
225
252
|
//# sourceMappingURL=docsUtils.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"docsUtils.js","sourceRoot":"","sources":["../../src/utils/docsUtils.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAC,OAAO,EAAC,MAAM,OAAO,CAAC;AAC9B,OAAO,EAAC,SAAS,EAAE,WAAW,EAAC,MAAM,oBAAoB,CAAC;AAC1D,OAAO,YAAY,MAAM,0BAA0B,CAAC;AACpD,OAAO,EACL,cAAc,EACd,eAAe,EACf,mBAAmB,EACnB,gBAAgB,GAIjB,MAAM,wCAAwC,CAAC;AAEhD,OAAO,EAAC,uBAAuB,EAAC,MAAM,kCAAkC,CAAC;AACzE,OAAO,EAAC,cAAc,EAAC,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAC,cAAc,EAAC,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAC,IAAI,EAAC,MAAM,WAAW,CAAC;AAC/B,OAAO,EAAC,UAAU,EAAC,MAAM,eAAe,CAAC;AASzC,qCAAqC;AACrC,MAAM,CAAC,MAAM,mBAAmB,GAAY,CAAC,CAAC,cAAc,CAAC;AAU7D,MAAM,UAAU,UAAU,CAAC,EAAsB;IAC/C,MAAM,OAAO,GAAG,cAAc,EAAE,CAAC;IACjC,IAAI,CAAC,EAAE,EAAE;QACP,OAAO,SAAS,CAAC;KAClB;IACD,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC7B,IAAI,CAAC,GAAG,EAAE;QACR,MAAM,IAAI,KAAK,CAAC,8BAA8B,EAAE,EAAE,CAAC,CAAC;KACrD;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,mBAAmB,CACjC,OAAoB,EACpB,SAAyD;IAEzD,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE;QAC1B,IAAI,IAAI,CAAC,IAAI,KAAK,UAAU,EAAE;YAC5B,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE;gBACnB,OAAO,IAAI,CAAC;aACb;YACD,MAAM,OAAO,GAAG,mBAAmB,CAAC,IAAI,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;YAC3D,IAAI,OAAO,EAAE;gBACX,OAAO,OAAO,CAAC;aAChB;SACF;KACF;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,qBAAqB,CACnC,IAA6B;IAE7B,IAAI,IAAI,CAAC,IAAI,EAAE;QACb,OAAO,IAAI,CAAC,IAAI,CAAC;KAClB;IAED,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,KAAK,EAAE;QAChC,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE;YAC3B,OAAO,OAAO,CAAC,IAAI,CAAC;SACrB;aAAM,IAAI,OAAO,CAAC,IAAI,KAAK,UAAU,EAAE;YACtC,MAAM,YAAY,GAAG,qBAAqB,CAAC,OAAO,CAAC,CAAC;YACpD,IAAI,YAAY,EAAE;gBAChB,OAAO,YAAY,CAAC;aACrB;SACF;QACD,wBAAwB;KACzB;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,yBAAyB;IACvC,MAAM,EAAC,QAAQ,EAAC,GAAG,WAAW,EAAE,CAAC;IACjC,MAAM,OAAO,GAAG,cAAc,EAAE,CAAC;IACjC,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;KACrE;IACD,MAAM,
|
|
1
|
+
{"version":3,"file":"docsUtils.js","sourceRoot":"","sources":["../../src/utils/docsUtils.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAC,OAAO,EAAC,MAAM,OAAO,CAAC;AAC9B,OAAO,EAAC,SAAS,EAAE,WAAW,EAAC,MAAM,oBAAoB,CAAC;AAC1D,OAAO,YAAY,MAAM,0BAA0B,CAAC;AACpD,OAAO,EACL,cAAc,EACd,eAAe,EACf,mBAAmB,EACnB,gBAAgB,GAIjB,MAAM,wCAAwC,CAAC;AAEhD,OAAO,EAAC,uBAAuB,EAAC,MAAM,kCAAkC,CAAC;AACzE,OAAO,EAAC,cAAc,EAAC,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAC,cAAc,EAAC,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAC,IAAI,EAAC,MAAM,WAAW,CAAC;AAC/B,OAAO,EAAC,UAAU,EAAC,MAAM,eAAe,CAAC;AASzC,qCAAqC;AACrC,MAAM,CAAC,MAAM,mBAAmB,GAAY,CAAC,CAAC,cAAc,CAAC;AAU7D,MAAM,UAAU,UAAU,CAAC,EAAsB;IAC/C,MAAM,OAAO,GAAG,cAAc,EAAE,CAAC;IACjC,IAAI,CAAC,EAAE,EAAE;QACP,OAAO,SAAS,CAAC;KAClB;IACD,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC7B,IAAI,CAAC,GAAG,EAAE;QACR,MAAM,IAAI,KAAK,CAAC,8BAA8B,EAAE,EAAE,CAAC,CAAC;KACrD;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,mBAAmB,CACjC,OAAoB,EACpB,SAAyD;IAEzD,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE;QAC1B,IAAI,IAAI,CAAC,IAAI,KAAK,UAAU,EAAE;YAC5B,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE;gBACnB,OAAO,IAAI,CAAC;aACb;YACD,MAAM,OAAO,GAAG,mBAAmB,CAAC,IAAI,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;YAC3D,IAAI,OAAO,EAAE;gBACX,OAAO,OAAO,CAAC;aAChB;SACF;KACF;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,qBAAqB,CACnC,IAA6B;IAE7B,IAAI,IAAI,CAAC,IAAI,EAAE;QACb,OAAO,IAAI,CAAC,IAAI,CAAC;KAClB;IAED,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,KAAK,EAAE;QAChC,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE;YAC3B,OAAO,OAAO,CAAC,IAAI,CAAC;SACrB;aAAM,IAAI,OAAO,CAAC,IAAI,KAAK,UAAU,EAAE;YACtC,MAAM,YAAY,GAAG,qBAAqB,CAAC,OAAO,CAAC,CAAC;YACpD,IAAI,YAAY,EAAE;gBAChB,OAAO,YAAY,CAAC;aACrB;SACF;QACD,wBAAwB;KACzB;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,yBAAyB;IACvC,MAAM,EAAC,QAAQ,EAAC,GAAG,WAAW,EAAE,CAAC;IACjC,MAAM,OAAO,GAAG,cAAc,EAAE,CAAC;IACjC,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;KACrE;IACD,MAAM,mBAAmB,GAAG,qBAAqB,CAAC;QAChD,YAAY,EAAE,OAAO,CAAC,KAAK;QAC3B,QAAQ;QACR,cAAc,EAAE,IAAI;KACrB,CAAC,CAAC;IACH,MAAM,eAAe,GAAG,mBAAmB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACzD,IAAI,CAAC,eAAe,EAAE;QACpB,MAAM,IAAI,KAAK,CACb,GAAG,QAAQ,8GAA8G,CAC1H,CAAC;KACH;IACD,OAAO,eAAe,CAAC;AACzB,CAAC;AAED,MAAM,QAAQ,GAAG,CAAC,UAA8B,EAAE,UAAkB,EAAE,EAAE,CACtE,OAAO,UAAU,KAAK,WAAW,IAAI,UAAU,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;AAC1E,MAAM,yBAAyB,GAAG,CAChC,KAAwB,EACxB,UAAkB,EAClB,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,mBAAmB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC;AAEvE;;GAEG;AACH,MAAM,UAAU,mBAAmB,CACjC,IAAqB,EACrB,UAAkB;IAElB,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE;QACxB,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;KACxC;IAED,IAAI,IAAI,CAAC,IAAI,KAAK,UAAU,EAAE;QAC5B,OAAO,CACL,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC;YAC/B,yBAAyB,CAAC,IAAI,CAAC,KAAK,EAAE,UAAU,CAAC,CAClD,CAAC;KACH;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAaD;;;GAGG;AACH,SAAS,qBAAqB,CAAC,EAC7B,YAAY,EACZ,QAAQ,EACR,cAAc,GAAG,KAAK,GAKvB;IACC,MAAM,WAAW,GAAiC,EAAE,CAAC;IAErD,SAAS,OAAO,CAAC,KAAwB;QACvC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,IACE,CAAC,IAAI,CAAC,IAAI,KAAK,UAAU;gBACvB,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;gBAC3D,CAAC,IAAI,CAAC,IAAI,KAAK,MAAM,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,EACzD;gBACA,MAAM,QAAQ,GAAG,cAAc,IAAI,IAAI,CAAC,IAAI,KAAK,UAAU,CAAC;gBAC5D,IAAI,CAAC,QAAQ,EAAE;oBACb,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;iBAC3B;gBACD,OAAO,IAAI,CAAC;aACb;SACF;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,CAAC,YAAY,CAAC,CAAC;IAEtB,OAAO,WAAW,CAAC;AACrB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,qBAAqB;IACnC,MAAM,OAAO,GAAG,cAAc,EAAE,CAAC;IACjC,MAAM,EAAC,QAAQ,EAAC,GAAG,WAAW,EAAE,CAAC;IACjC,MAAM,iBAAiB,GAAG,eAAe,EAAE,EAAE,UAAU,CAAC,WAAW,CAAC;IACpE,IAAI,iBAAiB,KAAK,KAAK,IAAI,CAAC,OAAO,EAAE;QAC3C,OAAO,IAAI,CAAC;KACb;IACD,OAAO,qBAAqB,CAAC,EAAC,YAAY,EAAE,OAAO,CAAC,KAAK,EAAE,QAAQ,EAAC,CAAC,CAAC;AACxE,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,wBAAwB,CACtC,YAAqB;IAErB,MAAM,EAAC,aAAa,EAAC,GAAG,mBAAmB,CAAC,YAAY,CAAC,CAAC;IAC1D,MAAM,EAAC,gBAAgB,EAAC,GAAG,uBAAuB,CAAC,YAAY,CAAC,CAAC;IACjE,MAAM,aAAa,GAAG,gBAAgB,CAAC,YAAY,CAAC,CAAC;IACrD,OAAO,OAAO,CACZ,GAAG,EAAE,CACH,IAAI,CACF,CAAC,aAAa,EAAE,gBAAgB,EAAE,aAAa,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAC1B,EAC1C,CAAC,aAAa,EAAE,gBAAgB,EAAE,aAAa,CAAC,CACjD,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,oBAAoB,CAClC,SAAiB,EACjB,YAAqB;IAErB,MAAM,QAAQ,GAAG,wBAAwB,CAAC,YAAY,CAAC,CAAC;IACxD,OAAO,OAAO,CAAC,GAAG,EAAE;QAClB,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAC/C,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CACzD,CAAC;QACF,MAAM,YAAY,GAAG,WAAW,CAAC,IAAI,CACnC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,SAAS,CACtC,CAAC;QACF,IAAI,CAAC,YAAY,EAAE;YACjB,MAAM,IAAI,KAAK,CACb,mCAAmC,SAAS,eAC1C,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAC9B,IAAI,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;;MAExD,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CACtC,CAAC;SACH;QACD,OAAO,YAAY,CAAC,CAAC,CAAC,CAAC;IACzB,CAAC,EAAE,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC;AAC5B,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,YAAY,CAC1B,KAAa,EACb,YAAqB;IAErB,MAAM,QAAQ,GAAG,wBAAwB,CAAC,YAAY,CAAC,CAAC;IACxD,OAAO,OAAO,CAAC,GAAG,EAAE;QAClB,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC5D,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,EAAE,KAAK,KAAK,CAAC,CAAC;QAClE,IAAI,CAAC,GAAG,EAAE;YACR,MAAM,OAAO,GAAG,QAAQ;iBACrB,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC;iBACtC,QAAQ,CAAC,KAAK,CAAC,CAAC;YACnB,yDAAyD;YACzD,IAAI,OAAO,EAAE;gBACX,OAAO,IAAI,CAAC;aACb;YACD,MAAM,IAAI,KAAK,CACb,iDAAiD,KAAK,eACpD,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAC9B,IAAI,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;;IAE1D,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAC5D,CAAC;SACH;QACD,OAAO,GAAG,CAAC;IACb,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC;AACxB,CAAC;AAED,sDAAsD;AACtD;;;;;;;;GAQG;AACH,MAAM,UAAU,mBAAmB,CAAC,EAClC,KAAK,EACL,eAAe,GACF;IAWb,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAC;IAC/B,MAAM,SAAS,GAAG,KAAK,CAAC,MAAO,CAAC;IAChC,MAAM,eAAe,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAClD,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,CACvC,CAAC;IACF,IAAI,CAAC,eAAe,EAAE;QACpB,OAAO,IAAI,CAAC;KACb;IAED,gEAAgE;IAChE,MAAM,WAAW,GAAG,eAAe,CAAC,OAAiB,CAAC;IAEtD,MAAM,YAAY,GAAG,WAAW;QAC9B,CAAC,CAAC,eAAe,CAAC,YAAY,CAAC,WAAW,CAAC;QAC3C,CAAC,CAAC,SAAS,CAAC;IAEd,MAAM,UAAU,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC;IAE3C,OAAO;QACL,UAAU;QACV,WAAW;QACX,YAAY;KACb,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,sBAAsB,CACpC,KAAwB;IAExB,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE;QAC3B,IAAI,IAAI,CAAC,IAAI,KAAK,UAAU,EAAE;YAC5B,OAAO,CAAC,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;SACtC;QACD,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,CAAC;AACL,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@docusaurus/theme-common",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.1.0",
|
|
4
4
|
"description": "Common code for Docusaurus themes.",
|
|
5
5
|
"main": "./lib/index.js",
|
|
6
6
|
"types": "./lib/index.d.ts",
|
|
@@ -30,12 +30,12 @@
|
|
|
30
30
|
},
|
|
31
31
|
"license": "MIT",
|
|
32
32
|
"dependencies": {
|
|
33
|
-
"@docusaurus/mdx-loader": "2.
|
|
34
|
-
"@docusaurus/module-type-aliases": "2.
|
|
35
|
-
"@docusaurus/plugin-content-blog": "2.
|
|
36
|
-
"@docusaurus/plugin-content-docs": "2.
|
|
37
|
-
"@docusaurus/plugin-content-pages": "2.
|
|
38
|
-
"@docusaurus/utils": "2.
|
|
33
|
+
"@docusaurus/mdx-loader": "2.1.0",
|
|
34
|
+
"@docusaurus/module-type-aliases": "2.1.0",
|
|
35
|
+
"@docusaurus/plugin-content-blog": "2.1.0",
|
|
36
|
+
"@docusaurus/plugin-content-docs": "2.1.0",
|
|
37
|
+
"@docusaurus/plugin-content-pages": "2.1.0",
|
|
38
|
+
"@docusaurus/utils": "2.1.0",
|
|
39
39
|
"@types/history": "^4.7.11",
|
|
40
40
|
"@types/react": "*",
|
|
41
41
|
"@types/react-router-config": "*",
|
|
@@ -46,8 +46,8 @@
|
|
|
46
46
|
"utility-types": "^3.10.0"
|
|
47
47
|
},
|
|
48
48
|
"devDependencies": {
|
|
49
|
-
"@docusaurus/core": "2.
|
|
50
|
-
"@docusaurus/types": "2.
|
|
49
|
+
"@docusaurus/core": "2.1.0",
|
|
50
|
+
"@docusaurus/types": "2.1.0",
|
|
51
51
|
"fs-extra": "^10.1.0",
|
|
52
52
|
"lodash": "^4.17.21"
|
|
53
53
|
},
|
|
@@ -58,5 +58,5 @@
|
|
|
58
58
|
"engines": {
|
|
59
59
|
"node": ">=16.14"
|
|
60
60
|
},
|
|
61
|
-
"gitHead": "
|
|
61
|
+
"gitHead": "be9b0942641184213485eba7fd75ceb0b328d3f4"
|
|
62
62
|
}
|
package/src/index.ts
CHANGED
|
@@ -28,7 +28,10 @@ export {createStorageSlot, listStorageKeys} from './utils/storageUtils';
|
|
|
28
28
|
|
|
29
29
|
export {useContextualSearchFilters} from './utils/searchUtils';
|
|
30
30
|
|
|
31
|
-
export {
|
|
31
|
+
export {
|
|
32
|
+
useCurrentSidebarCategory,
|
|
33
|
+
filterDocCardListItems,
|
|
34
|
+
} from './utils/docsUtils';
|
|
32
35
|
|
|
33
36
|
export {usePluralForm} from './utils/usePluralForm';
|
|
34
37
|
|
package/src/utils/docsUtils.tsx
CHANGED
|
@@ -110,15 +110,18 @@ export function useCurrentSidebarCategory(): PropSidebarItemCategory {
|
|
|
110
110
|
if (!sidebar) {
|
|
111
111
|
throw new Error('Unexpected: cant find current sidebar in context');
|
|
112
112
|
}
|
|
113
|
-
const
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
113
|
+
const categoryBreadcrumbs = getSidebarBreadcrumbs({
|
|
114
|
+
sidebarItems: sidebar.items,
|
|
115
|
+
pathname,
|
|
116
|
+
onlyCategories: true,
|
|
117
|
+
});
|
|
118
|
+
const deepestCategory = categoryBreadcrumbs.slice(-1)[0];
|
|
119
|
+
if (!deepestCategory) {
|
|
117
120
|
throw new Error(
|
|
118
121
|
`${pathname} is not associated with a category. useCurrentSidebarCategory() should only be used on category index pages.`,
|
|
119
122
|
);
|
|
120
123
|
}
|
|
121
|
-
return
|
|
124
|
+
return deepestCategory;
|
|
122
125
|
}
|
|
123
126
|
|
|
124
127
|
const isActive = (testedPath: string | undefined, activePath: string) =>
|
|
@@ -149,29 +152,43 @@ export function isActiveSidebarItem(
|
|
|
149
152
|
return false;
|
|
150
153
|
}
|
|
151
154
|
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
const sidebar = useDocsSidebar();
|
|
158
|
-
const {pathname} = useLocation();
|
|
159
|
-
const breadcrumbsOption = useActivePlugin()?.pluginData.breadcrumbs;
|
|
155
|
+
function getSidebarBreadcrumbs(param: {
|
|
156
|
+
sidebarItems: PropSidebar;
|
|
157
|
+
pathname: string;
|
|
158
|
+
onlyCategories: true;
|
|
159
|
+
}): PropSidebarItemCategory[];
|
|
160
160
|
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
161
|
+
function getSidebarBreadcrumbs(param: {
|
|
162
|
+
sidebarItems: PropSidebar;
|
|
163
|
+
pathname: string;
|
|
164
|
+
}): PropSidebarBreadcrumbsItem[];
|
|
164
165
|
|
|
166
|
+
/**
|
|
167
|
+
* Get the sidebar the breadcrumbs for a given pathname
|
|
168
|
+
* Ordered from top to bottom
|
|
169
|
+
*/
|
|
170
|
+
function getSidebarBreadcrumbs({
|
|
171
|
+
sidebarItems,
|
|
172
|
+
pathname,
|
|
173
|
+
onlyCategories = false,
|
|
174
|
+
}: {
|
|
175
|
+
sidebarItems: PropSidebar;
|
|
176
|
+
pathname: string;
|
|
177
|
+
onlyCategories?: boolean;
|
|
178
|
+
}): PropSidebarBreadcrumbsItem[] {
|
|
165
179
|
const breadcrumbs: PropSidebarBreadcrumbsItem[] = [];
|
|
166
180
|
|
|
167
|
-
function extract(items:
|
|
181
|
+
function extract(items: PropSidebarItem[]) {
|
|
168
182
|
for (const item of items) {
|
|
169
183
|
if (
|
|
170
184
|
(item.type === 'category' &&
|
|
171
185
|
(isSamePath(item.href, pathname) || extract(item.items))) ||
|
|
172
186
|
(item.type === 'link' && isSamePath(item.href, pathname))
|
|
173
187
|
) {
|
|
174
|
-
|
|
188
|
+
const filtered = onlyCategories && item.type !== 'category';
|
|
189
|
+
if (!filtered) {
|
|
190
|
+
breadcrumbs.unshift(item);
|
|
191
|
+
}
|
|
175
192
|
return true;
|
|
176
193
|
}
|
|
177
194
|
}
|
|
@@ -179,9 +196,23 @@ export function useSidebarBreadcrumbs(): PropSidebarBreadcrumbsItem[] | null {
|
|
|
179
196
|
return false;
|
|
180
197
|
}
|
|
181
198
|
|
|
182
|
-
extract(
|
|
199
|
+
extract(sidebarItems);
|
|
200
|
+
|
|
201
|
+
return breadcrumbs;
|
|
202
|
+
}
|
|
183
203
|
|
|
184
|
-
|
|
204
|
+
/**
|
|
205
|
+
* Gets the breadcrumbs of the current doc page, based on its sidebar location.
|
|
206
|
+
* Returns `null` if there's no sidebar or breadcrumbs are disabled.
|
|
207
|
+
*/
|
|
208
|
+
export function useSidebarBreadcrumbs(): PropSidebarBreadcrumbsItem[] | null {
|
|
209
|
+
const sidebar = useDocsSidebar();
|
|
210
|
+
const {pathname} = useLocation();
|
|
211
|
+
const breadcrumbsOption = useActivePlugin()?.pluginData.breadcrumbs;
|
|
212
|
+
if (breadcrumbsOption === false || !sidebar) {
|
|
213
|
+
return null;
|
|
214
|
+
}
|
|
215
|
+
return getSidebarBreadcrumbs({sidebarItems: sidebar.items, pathname});
|
|
185
216
|
}
|
|
186
217
|
|
|
187
218
|
/**
|
|
@@ -332,3 +363,18 @@ export function useDocRouteMetadata({
|
|
|
332
363
|
sidebarItems,
|
|
333
364
|
};
|
|
334
365
|
}
|
|
366
|
+
|
|
367
|
+
/**
|
|
368
|
+
* Filter categories that don't have a link.
|
|
369
|
+
* @param items
|
|
370
|
+
*/
|
|
371
|
+
export function filterDocCardListItems(
|
|
372
|
+
items: PropSidebarItem[],
|
|
373
|
+
): PropSidebarItem[] {
|
|
374
|
+
return items.filter((item) => {
|
|
375
|
+
if (item.type === 'category') {
|
|
376
|
+
return !!findFirstCategoryLink(item);
|
|
377
|
+
}
|
|
378
|
+
return true;
|
|
379
|
+
});
|
|
380
|
+
}
|