npm - @docusaurus/theme-common - Versions diffs - 2.0.0-beta.fbdeefcac → 2.0.0-rc.1 - Mend

@docusaurus/theme-common 2.0.0-beta.fbdeefcac → 2.0.0-rc.1

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.

Files changed (270) hide show

package/lib/components/Collapsible/index.d.ts +64 -0
package/lib/components/Collapsible/index.d.ts.map +1 -0
package/lib/components/Collapsible/index.js +150 -0
package/lib/components/Collapsible/index.js.map +1 -0
package/lib/components/Details/index.d.ts +17 -0
package/lib/components/Details/index.d.ts.map +1 -0
package/lib/components/Details/index.js +76 -0
package/lib/components/Details/index.js.map +1 -0
package/lib/components/Details/styles.module.css +62 -0
package/lib/contexts/announcementBar.d.ts +22 -0
package/lib/contexts/announcementBar.d.ts.map +1 -0
package/lib/{utils/announcementBarUtils.js → contexts/announcementBar.js} +30 -31
package/lib/contexts/announcementBar.js.map +1 -0
package/lib/contexts/blogPost.d.ts +33 -0
package/lib/contexts/blogPost.d.ts.map +1 -0
package/lib/contexts/blogPost.js +46 -0
package/lib/contexts/blogPost.js.map +1 -0
package/lib/contexts/colorMode.d.ts +27 -0
package/lib/contexts/colorMode.d.ts.map +1 -0
package/lib/contexts/colorMode.js +132 -0
package/lib/contexts/colorMode.js.map +1 -0
package/lib/contexts/doc.d.ts +30 -0
package/lib/contexts/doc.d.ts.map +1 -0
package/lib/contexts/doc.js +48 -0
package/lib/contexts/doc.js.map +1 -0
package/lib/contexts/docSidebarItemsExpandedState.d.ts +31 -0
package/lib/contexts/docSidebarItemsExpandedState.d.ts.map +1 -0
package/lib/contexts/docSidebarItemsExpandedState.js +28 -0
package/lib/contexts/docSidebarItemsExpandedState.js.map +1 -0
package/lib/contexts/docsPreferredVersion.d.ts +30 -0
package/lib/contexts/docsPreferredVersion.d.ts.map +1 -0
package/lib/contexts/docsPreferredVersion.js +130 -0
package/lib/contexts/docsPreferredVersion.js.map +1 -0
package/lib/contexts/docsSidebar.d.ts +26 -0
package/lib/contexts/docsSidebar.d.ts.map +1 -0
package/lib/contexts/docsSidebar.js +30 -0
package/lib/contexts/docsSidebar.js.map +1 -0
package/lib/contexts/docsVersion.d.ts +20 -0
package/lib/contexts/docsVersion.d.ts.map +1 -0
package/lib/contexts/docsVersion.js +26 -0
package/lib/contexts/docsVersion.js.map +1 -0
package/lib/contexts/navbarMobileSidebar.d.ts +31 -0
package/lib/contexts/navbarMobileSidebar.d.ts.map +1 -0
package/lib/contexts/navbarMobileSidebar.js +56 -0
package/lib/contexts/navbarMobileSidebar.js.map +1 -0
package/lib/contexts/navbarSecondaryMenu/content.d.ts +37 -0
package/lib/contexts/navbarSecondaryMenu/content.d.ts.map +1 -0
package/lib/contexts/navbarSecondaryMenu/content.js +50 -0
package/lib/contexts/navbarSecondaryMenu/content.js.map +1 -0
package/lib/contexts/navbarSecondaryMenu/display.d.ts +24 -0
package/lib/contexts/navbarSecondaryMenu/display.d.ts.map +1 -0
package/lib/contexts/navbarSecondaryMenu/display.js +62 -0
package/lib/contexts/navbarSecondaryMenu/display.js.map +1 -0
package/lib/contexts/tabGroupChoice.d.ts +21 -0
package/lib/contexts/tabGroupChoice.d.ts.map +1 -0
package/lib/contexts/tabGroupChoice.js +49 -0
package/lib/contexts/tabGroupChoice.js.map +1 -0
package/lib/{utils/usePrevious.d.ts → hooks/styles.css} +4 -1
package/lib/hooks/useBackToTopButton.d.ts +27 -0
package/lib/hooks/useBackToTopButton.d.ts.map +1 -0
package/lib/hooks/useBackToTopButton.js +50 -0
package/lib/hooks/useBackToTopButton.js.map +1 -0
package/lib/hooks/useCodeWordWrap.d.ts +14 -0
package/lib/hooks/useCodeWordWrap.d.ts.map +1 -0
package/lib/hooks/useCodeWordWrap.js +67 -0
package/lib/hooks/useCodeWordWrap.js.map +1 -0
package/lib/hooks/useHideableNavbar.d.ts +17 -0
package/lib/hooks/useHideableNavbar.d.ts.map +1 -0
package/lib/hooks/useHideableNavbar.js +60 -0
package/lib/hooks/useHideableNavbar.js.map +1 -0
package/lib/hooks/useKeyboardNavigation.d.ts +20 -0
package/lib/hooks/useKeyboardNavigation.d.ts.map +1 -0
package/lib/hooks/useKeyboardNavigation.js +39 -0
package/lib/hooks/useKeyboardNavigation.js.map +1 -0
package/lib/hooks/useLockBodyScroll.d.ts +12 -0
package/lib/hooks/useLockBodyScroll.d.ts.map +1 -0
package/lib/hooks/useLockBodyScroll.js +20 -0
package/lib/hooks/useLockBodyScroll.js.map +1 -0
package/lib/hooks/useMutationObserver.d.ts +4 -0
package/lib/hooks/useMutationObserver.d.ts.map +1 -0
package/lib/hooks/useMutationObserver.js +29 -0
package/lib/hooks/useMutationObserver.js.map +1 -0
package/lib/hooks/usePrismTheme.d.ts +13 -0
package/lib/hooks/usePrismTheme.d.ts.map +1 -0
package/lib/hooks/usePrismTheme.js +21 -0
package/lib/hooks/usePrismTheme.js.map +1 -0
package/lib/hooks/useSearchPage.d.ts +25 -0
package/lib/hooks/useSearchPage.d.ts.map +1 -0
package/lib/hooks/useSearchPage.js +43 -0
package/lib/hooks/useSearchPage.js.map +1 -0
package/lib/hooks/useSkipToContent.d.ts +25 -0
package/lib/hooks/useSkipToContent.d.ts.map +1 -0
package/lib/hooks/useSkipToContent.js +35 -0
package/lib/hooks/useSkipToContent.js.map +1 -0
package/lib/hooks/useTOCHighlight.d.ts +25 -0
package/lib/hooks/useTOCHighlight.d.ts.map +1 -0
package/lib/hooks/useTOCHighlight.js +130 -0
package/lib/hooks/useTOCHighlight.js.map +1 -0
package/lib/hooks/useWindowSize.d.ts +28 -0
package/lib/hooks/useWindowSize.d.ts.map +1 -0
package/lib/hooks/useWindowSize.js +59 -0
package/lib/hooks/useWindowSize.js.map +1 -0
package/lib/index.d.ts +16 -13
package/lib/index.d.ts.map +1 -0
package/lib/index.js +23 -12
package/lib/index.js.map +1 -0
package/lib/internal.d.ts +41 -0
package/lib/internal.d.ts.map +1 -0
package/lib/internal.js +52 -0
package/lib/internal.js.map +1 -0
package/lib/utils/ThemeClassNames.d.ts +49 -12
package/lib/utils/ThemeClassNames.d.ts.map +1 -0
package/lib/utils/ThemeClassNames.js +47 -4
package/lib/utils/ThemeClassNames.js.map +1 -0
package/lib/utils/codeBlockUtils.d.ts +63 -0
package/lib/utils/codeBlockUtils.d.ts.map +1 -0
package/lib/utils/codeBlockUtils.js +159 -3
package/lib/utils/codeBlockUtils.js.map +1 -0
package/lib/utils/docsUtils.d.ts +91 -0
package/lib/utils/docsUtils.d.ts.map +1 -0
package/lib/utils/docsUtils.js +217 -1
package/lib/utils/docsUtils.js.map +1 -0
package/lib/utils/footerUtils.d.ts +13 -0
package/lib/utils/footerUtils.d.ts.map +1 -0
package/lib/utils/footerUtils.js +14 -0
package/lib/utils/footerUtils.js.map +1 -0
package/lib/utils/generalUtils.d.ts +11 -1
package/lib/utils/generalUtils.d.ts.map +1 -0
package/lib/utils/generalUtils.js +9 -5
package/lib/utils/generalUtils.js.map +1 -0
package/lib/utils/historyUtils.d.ts +17 -0
package/lib/utils/historyUtils.d.ts.map +1 -0
package/lib/utils/historyUtils.js +38 -0
package/lib/utils/historyUtils.js.map +1 -0
package/lib/utils/jsUtils.d.ts +23 -0
package/lib/utils/jsUtils.d.ts.map +1 -0
package/lib/utils/jsUtils.js +29 -0
package/lib/utils/jsUtils.js.map +1 -0
package/lib/utils/metadataUtils.d.ts +38 -0
package/lib/utils/metadataUtils.d.ts.map +1 -0
package/lib/utils/metadataUtils.js +70 -0
package/lib/utils/metadataUtils.js.map +1 -0
package/lib/utils/navbarUtils.d.ts +21 -0
package/lib/utils/navbarUtils.d.ts.map +1 -0
package/lib/utils/navbarUtils.js +36 -0
package/lib/utils/navbarUtils.js.map +1 -0
package/lib/utils/reactUtils.d.ts +69 -0
package/lib/utils/reactUtils.d.ts.map +1 -0
package/lib/utils/reactUtils.js +98 -0
package/lib/utils/reactUtils.js.map +1 -0
package/lib/utils/regexpUtils.d.ts +12 -0
package/lib/utils/regexpUtils.d.ts.map +1 -0
package/lib/utils/regexpUtils.js +18 -0
package/lib/utils/regexpUtils.js.map +1 -0
package/lib/utils/routesUtils.d.ts +26 -0
package/lib/utils/routesUtils.d.ts.map +1 -0
package/lib/utils/routesUtils.js +54 -0
package/lib/utils/routesUtils.js.map +1 -0
package/lib/utils/scrollUtils.d.ts +83 -0
package/lib/utils/scrollUtils.d.ts.map +1 -0
package/lib/utils/scrollUtils.js +200 -0
package/lib/utils/scrollUtils.js.map +1 -0
package/lib/utils/searchUtils.d.ts +13 -0
package/lib/utils/searchUtils.d.ts.map +1 -0
package/lib/utils/searchUtils.js +37 -0
package/lib/utils/searchUtils.js.map +1 -0
package/lib/utils/storageUtils.d.ts +15 -7
package/lib/utils/storageUtils.d.ts.map +1 -0
package/lib/utils/storageUtils.js +55 -22
package/lib/utils/storageUtils.js.map +1 -0
package/lib/utils/tagsUtils.d.ts +18 -0
package/lib/utils/tagsUtils.d.ts.map +1 -0
package/lib/utils/tagsUtils.js +36 -0
package/lib/utils/tagsUtils.js.map +1 -0
package/lib/utils/tocUtils.d.ts +36 -0
package/lib/utils/tocUtils.d.ts.map +1 -0
package/lib/utils/tocUtils.js +84 -0
package/lib/utils/tocUtils.js.map +1 -0
package/lib/utils/useAlternatePageUtils.d.ts +21 -1
package/lib/utils/useAlternatePageUtils.d.ts.map +1 -0
package/lib/utils/useAlternatePageUtils.js +9 -4
package/lib/utils/useAlternatePageUtils.js.map +1 -0
package/lib/utils/useLocalPathname.d.ts +13 -0
package/lib/utils/useLocalPathname.d.ts.map +1 -0
package/lib/utils/useLocalPathname.js +19 -0
package/lib/utils/useLocalPathname.js.map +1 -0
package/lib/utils/useLocationChange.d.ts +9 -6
package/lib/utils/useLocationChange.d.ts.map +1 -0
package/lib/utils/useLocationChange.js +17 -11
package/lib/utils/useLocationChange.js.map +1 -0
package/lib/utils/usePluralForm.d.ts +12 -0
package/lib/utils/usePluralForm.d.ts.map +1 -0
package/lib/utils/usePluralForm.js +36 -37
package/lib/utils/usePluralForm.js.map +1 -0
package/lib/utils/useThemeConfig.d.ts +56 -28
package/lib/utils/useThemeConfig.d.ts.map +1 -0
package/lib/utils/useThemeConfig.js +4 -0
package/lib/utils/useThemeConfig.js.map +1 -0
package/package.json +35 -13
package/src/components/Collapsible/index.tsx +263 -0
package/src/components/Details/index.tsx +109 -0
package/src/components/Details/styles.module.css +62 -0
package/src/{utils/announcementBarUtils.tsx → contexts/announcementBar.tsx} +43 -39
package/src/contexts/blogPost.tsx +80 -0
package/src/contexts/colorMode.tsx +198 -0
package/src/contexts/doc.tsx +71 -0
package/src/contexts/docSidebarItemsExpandedState.tsx +55 -0
package/src/contexts/docsPreferredVersion.tsx +251 -0
package/src/contexts/docsSidebar.tsx +50 -0
package/src/contexts/docsVersion.tsx +36 -0
package/src/contexts/navbarMobileSidebar.tsx +99 -0
package/src/contexts/navbarSecondaryMenu/content.tsx +100 -0
package/src/contexts/navbarSecondaryMenu/display.tsx +102 -0
package/src/contexts/tabGroupChoice.tsx +85 -0
package/{lib/utils/pathUtils.d.ts → src/hooks/styles.css} +4 -1
package/src/hooks/useBackToTopButton.ts +73 -0
package/src/hooks/useCodeWordWrap.ts +105 -0
package/src/hooks/useHideableNavbar.ts +75 -0
package/src/hooks/useKeyboardNavigation.ts +45 -0
package/src/hooks/useLockBodyScroll.ts +21 -0
package/src/hooks/useMutationObserver.ts +38 -0
package/src/hooks/usePrismTheme.ts +24 -0
package/src/hooks/useSearchPage.ts +79 -0
package/src/hooks/useSkipToContent.ts +58 -0
package/src/hooks/useTOCHighlight.ts +189 -0
package/src/hooks/useWindowSize.ts +72 -0
package/src/index.ts +53 -28
package/src/internal.ts +122 -0
package/src/types.d.ts +0 -2
package/src/utils/ThemeClassNames.ts +54 -5
package/src/utils/codeBlockUtils.ts +241 -2
package/src/utils/docsUtils.tsx +334 -0
package/src/utils/footerUtils.ts +18 -0
package/src/utils/generalUtils.ts +9 -5
package/src/utils/historyUtils.ts +45 -0
package/src/utils/jsUtils.ts +36 -0
package/src/utils/metadataUtils.tsx +115 -0
package/src/utils/navbarUtils.tsx +45 -0
package/src/utils/reactUtils.tsx +129 -0
package/src/utils/regexpUtils.ts +24 -0
package/src/utils/routesUtils.ts +75 -0
package/src/utils/scrollUtils.tsx +304 -0
package/src/utils/searchUtils.ts +51 -0
package/src/utils/storageUtils.ts +56 -23
package/src/utils/tagsUtils.ts +50 -0
package/src/utils/tocUtils.ts +119 -0
package/src/utils/useAlternatePageUtils.ts +19 -6
package/src/utils/useLocalPathname.ts +22 -0
package/src/utils/useLocationChange.ts +24 -20
package/src/utils/usePluralForm.ts +50 -38
package/src/utils/useThemeConfig.ts +55 -30
package/lib/.tsbuildinfo +0 -1
package/lib/utils/announcementBarUtils.d.ts +0 -17
package/lib/utils/docsPreferredVersion/DocsPreferredVersionProvider.d.ts +0 -21
package/lib/utils/docsPreferredVersion/DocsPreferredVersionProvider.js +0 -94
package/lib/utils/docsPreferredVersion/DocsPreferredVersionStorage.d.ts +0 -13
package/lib/utils/docsPreferredVersion/DocsPreferredVersionStorage.js +0 -20
package/lib/utils/docsPreferredVersion/useDocsPreferredVersion.d.ts +0 -5
package/lib/utils/docsPreferredVersion/useDocsPreferredVersion.js +0 -41
package/lib/utils/pathUtils.js +0 -13
package/lib/utils/usePrevious.js +0 -14
package/src/utils/__tests__/codeBlockUtils.test.ts +0 -54
package/src/utils/__tests__/pathUtils.test.ts +0 -32
package/src/utils/docsPreferredVersion/DocsPreferredVersionProvider.tsx +0 -165
package/src/utils/docsPreferredVersion/DocsPreferredVersionStorage.ts +0 -34
package/src/utils/docsPreferredVersion/useDocsPreferredVersion.ts +0 -66
package/src/utils/docsUtils.ts +0 -11
package/src/utils/pathUtils.ts +0 -17
package/src/utils/usePrevious.ts +0 -18
package/tsconfig.json +0 -10

package/lib/utils/metadataUtils.js ADDED Viewed

@@ -0,0 +1,70 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import React from 'react';
+import clsx from 'clsx';
+import Head from '@docusaurus/Head';
+import useRouteContext from '@docusaurus/useRouteContext';
+import { useBaseUrlUtils } from '@docusaurus/useBaseUrl';
+import { useTitleFormatter } from './generalUtils';
+/**
+ * Helper component to manipulate page metadata and override site defaults.
+ * Works in the same way as Helmet.
+ */
+export function PageMetadata({ title, description, keywords, image, children, }) {
+    const pageTitle = useTitleFormatter(title);
+    const { withBaseUrl } = useBaseUrlUtils();
+    const pageImage = image ? withBaseUrl(image, { absolute: true }) : undefined;
+    return (<Head>
+      {title && <title>{pageTitle}</title>}
+      {title && <meta property="og:title" content={pageTitle}/>}
+      {description && <meta name="description" content={description}/>}
+      {description && <meta property="og:description" content={description}/>}
+      {keywords && (<meta name="keywords" content={
+            // https://github.com/microsoft/TypeScript/issues/17002
+            (Array.isArray(keywords) ? keywords.join(',') : keywords)}/>)}
+      {pageImage && <meta property="og:image" content={pageImage}/>}
+      {pageImage && <meta name="twitter:image" content={pageImage}/>}
+      {children}
+    </Head>);
+}
+const HtmlClassNameContext = React.createContext(undefined);
+/**
+ * Every layer of this provider will append a class name to the HTML element.
+ * There's no consumer for this hook: it's side-effect-only. This wrapper is
+ * necessary because Helmet does not "merge" classes.
+ * @see https://github.com/staylor/react-helmet-async/issues/161
+ */
+export function HtmlClassNameProvider({ className: classNameProp, children, }) {
+    const classNameContext = React.useContext(HtmlClassNameContext);
+    const className = clsx(classNameContext, classNameProp);
+    return (<HtmlClassNameContext.Provider value={className}>
+      <Head>
+        <html className={className}/>
+      </Head>
+      {children}
+    </HtmlClassNameContext.Provider>);
+}
+function pluginNameToClassName(pluginName) {
+    return `plugin-${pluginName.replace(/docusaurus-(?:plugin|theme)-(?:content-)?/gi, '')}`;
+}
+/**
+ * A very thin wrapper around `HtmlClassNameProvider` that adds the plugin ID +
+ * name to the HTML class name.
+ */
+export function PluginHtmlClassNameProvider({ children, }) {
+    const routeContext = useRouteContext();
+    const nameClass = pluginNameToClassName(routeContext.plugin.name);
+    const idClass = `plugin-id-${routeContext.plugin.id}`;
+    return (<HtmlClassNameProvider className={clsx(nameClass, idClass)}>
+      {children}
+    </HtmlClassNameProvider>);
+}
+//# sourceMappingURL=metadataUtils.js.map

package/lib/utils/metadataUtils.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"metadataUtils.js","sourceRoot":"","sources":["../../src/utils/metadataUtils.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAuB,MAAM,OAAO,CAAC;AAC5C,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,IAAI,MAAM,kBAAkB,CAAC;AACpC,OAAO,eAAe,MAAM,6BAA6B,CAAC;AAC1D,OAAO,EAAC,eAAe,EAAC,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAC,iBAAiB,EAAC,MAAM,gBAAgB,CAAC;AAUjD;;;GAGG;AACH,MAAM,UAAU,YAAY,CAAC,EAC3B,KAAK,EACL,WAAW,EACX,QAAQ,EACR,KAAK,EACL,QAAQ,GACU;IAClB,MAAM,SAAS,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAC3C,MAAM,EAAC,WAAW,EAAC,GAAG,eAAe,EAAE,CAAC;IACxC,MAAM,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC,WAAW,CAAC,KAAK,EAAE,EAAC,QAAQ,EAAE,IAAI,EAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAE3E,OAAO,CACL,CAAC,IAAI,CACH;MAAA,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,EAAE,KAAK,CAAC,CACpC;MAAA,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,EAAG,CAE1D;;MAAA,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,WAAW,CAAC,EAAG,CACjE;MAAA,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,WAAW,CAAC,EAAG,CAExE;;MAAA,CAAC,QAAQ,IAAI,CACX,CAAC,IAAI,CACH,IAAI,CAAC,UAAU,CACf,OAAO,CAAC;YACN,uDAAuD;YACvD,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAW,CACpE,EACD,CACH,CAED;;MAAA,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,EAAG,CAC9D;MAAA,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,EAAG,CAE/D;;MAAA,CAAC,QAAQ,CACX;IAAA,EAAE,IAAI,CAAC,CACR,CAAC;AACJ,CAAC;AAED,MAAM,oBAAoB,GAAG,KAAK,CAAC,aAAa,CAAqB,SAAS,CAAC,CAAC;AAEhF;;;;;GAKG;AACH,MAAM,UAAU,qBAAqB,CAAC,EACpC,SAAS,EAAE,aAAa,EACxB,QAAQ,GAIT;IACC,MAAM,gBAAgB,GAAG,KAAK,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAC;IAChE,MAAM,SAAS,GAAG,IAAI,CAAC,gBAAgB,EAAE,aAAa,CAAC,CAAC;IACxD,OAAO,CACL,CAAC,oBAAoB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,CAC9C;MAAA,CAAC,IAAI,CACH;QAAA,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,EAC7B;MAAA,EAAE,IAAI,CACN;MAAA,CAAC,QAAQ,CACX;IAAA,EAAE,oBAAoB,CAAC,QAAQ,CAAC,CACjC,CAAC;AACJ,CAAC;AAED,SAAS,qBAAqB,CAAC,UAAkB;IAC/C,OAAO,UAAU,UAAU,CAAC,OAAO,CACjC,6CAA6C,EAC7C,EAAE,CACH,EAAE,CAAC;AACN,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,2BAA2B,CAAC,EAC1C,QAAQ,GAGT;IACC,MAAM,YAAY,GAAG,eAAe,EAAE,CAAC;IACvC,MAAM,SAAS,GAAG,qBAAqB,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAClE,MAAM,OAAO,GAAG,aAAa,YAAY,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;IACtD,OAAO,CACL,CAAC,qBAAqB,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CACzD;MAAA,CAAC,QAAQ,CACX;IAAA,EAAE,qBAAqB,CAAC,CACzB,CAAC;AACJ,CAAC"}

package/lib/utils/navbarUtils.d.ts ADDED Viewed

@@ -0,0 +1,21 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * 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';
+/**
+ * Split links by left/right. If position is unspecified, fallback to right.
+ */
+export declare function splitNavbarItems<T extends {
+    position?: 'left' | 'right';
+}>(items: T[]): [leftItems: T[], rightItems: T[]];
+/**
+ * Composes multiple navbar state providers that are mutually dependent and
+ * hence can't be re-ordered.
+ */
+export declare function NavbarProvider({ children }: {
+    children: ReactNode;
+}): JSX.Element;
+//# sourceMappingURL=navbarUtils.d.ts.map

package/lib/utils/navbarUtils.d.ts.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"navbarUtils.d.ts","sourceRoot":"","sources":["../../src/utils/navbarUtils.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAc,EAAC,KAAK,SAAS,EAAC,MAAM,OAAO,CAAC;AAO5C;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,SAAS;IAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;CAAC,EACtE,KAAK,EAAE,CAAC,EAAE,GACT,CAAC,SAAS,EAAE,CAAC,EAAE,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC,CASnC;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,EAAC,QAAQ,EAAC,EAAE;IAAC,QAAQ,EAAE,SAAS,CAAA;CAAC,GAAG,GAAG,CAAC,OAAO,CAU7E"}

package/lib/utils/navbarUtils.js ADDED Viewed

@@ -0,0 +1,36 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import React from 'react';
+import { NavbarMobileSidebarProvider } from '../contexts/navbarMobileSidebar';
+import { NavbarSecondaryMenuContentProvider } from '../contexts/navbarSecondaryMenu/content';
+import { NavbarSecondaryMenuDisplayProvider } from '../contexts/navbarSecondaryMenu/display';
+const DefaultNavItemPosition = 'right';
+/**
+ * Split links by left/right. If position is unspecified, fallback to right.
+ */
+export function splitNavbarItems(items) {
+    function isLeft(item) {
+        return (item.position ?? DefaultNavItemPosition) === 'left';
+    }
+    const leftItems = items.filter(isLeft);
+    const rightItems = items.filter((item) => !isLeft(item));
+    return [leftItems, rightItems];
+}
+/**
+ * Composes multiple navbar state providers that are mutually dependent and
+ * hence can't be re-ordered.
+ */
+export function NavbarProvider({ children }) {
+    return (<NavbarSecondaryMenuContentProvider>
+      <NavbarMobileSidebarProvider>
+        <NavbarSecondaryMenuDisplayProvider>
+          {children}
+        </NavbarSecondaryMenuDisplayProvider>
+      </NavbarMobileSidebarProvider>
+    </NavbarSecondaryMenuContentProvider>);
+}
+//# sourceMappingURL=navbarUtils.js.map

package/lib/utils/navbarUtils.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"navbarUtils.js","sourceRoot":"","sources":["../../src/utils/navbarUtils.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAuB,MAAM,OAAO,CAAC;AAC5C,OAAO,EAAC,2BAA2B,EAAC,MAAM,iCAAiC,CAAC;AAC5E,OAAO,EAAC,kCAAkC,EAAC,MAAM,yCAAyC,CAAC;AAC3F,OAAO,EAAC,kCAAkC,EAAC,MAAM,yCAAyC,CAAC;AAE3F,MAAM,sBAAsB,GAAG,OAAO,CAAC;AAEvC;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAC9B,KAAU;IAEV,SAAS,MAAM,CAAC,IAAO;QACrB,OAAO,CAAC,IAAI,CAAC,QAAQ,IAAI,sBAAsB,CAAC,KAAK,MAAM,CAAC;IAC9D,CAAC;IAED,MAAM,SAAS,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACvC,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IAEzD,OAAO,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;AACjC,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,cAAc,CAAC,EAAC,QAAQ,EAAwB;IAC9D,OAAO,CACL,CAAC,kCAAkC,CACjC;MAAA,CAAC,2BAA2B,CAC1B;QAAA,CAAC,kCAAkC,CACjC;UAAA,CAAC,QAAQ,CACX;QAAA,EAAE,kCAAkC,CACtC;MAAA,EAAE,2BAA2B,CAC/B;IAAA,EAAE,kCAAkC,CAAC,CACtC,CAAC;AACJ,CAAC"}

package/lib/utils/reactUtils.d.ts ADDED Viewed

@@ -0,0 +1,69 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import React, { type ComponentType, type ReactNode } from 'react';
+/**
+ * This hook is like `useLayoutEffect`, but without the SSR warning.
+ * It seems hacky but it's used in many React libs (Redux, Formik...).
+ * Also mentioned here: https://github.com/facebook/react/issues/16956
+ *
+ * It is useful when you need to update a ref as soon as possible after a React
+ * render (before `useEffect`).
+ */
+export declare const useIsomorphicLayoutEffect: typeof React.useLayoutEffect;
+/**
+ * Temporary userland implementation until an official hook is implemented
+ * See RFC: https://github.com/reactjs/rfcs/pull/220
+ *
+ * Permits to transform an unstable callback (like an arrow function provided as
+ * props) to a "stable" callback that is safe to use in a `useEffect` dependency
+ * array. Useful to avoid React stale closure problems + avoid useless effect
+ * re-executions.
+ *
+ * This generally works but has some potential drawbacks, such as
+ * https://github.com/facebook/react/issues/16956#issuecomment-536636418
+ */
+export declare function useEvent<T extends (...args: never[]) => unknown>(callback: T): T;
+/**
+ * Gets `value` from the last render.
+ */
+export declare function usePrevious<T>(value: T): T | undefined;
+/**
+ * This error is thrown when a context is consumed outside its provider. Allows
+ * reusing a generic error message format and reduces bundle size. The hook's
+ * name will be extracted from its stack, so only the provider's name is needed.
+ */
+export declare class ReactContextError extends Error {
+    constructor(providerName: string, additionalInfo?: string);
+}
+/**
+ * Shallow-memoize an object. This means the returned object will be the same as
+ * the previous render if the property keys and values did not change. This
+ * works for simple cases: when property values are primitives or stable
+ * objects.
+ *
+ * @param obj
+ */
+export declare function useShallowMemoObject<O extends object>(obj: O): O;
+declare type SimpleProvider = ComponentType<{
+    children: ReactNode;
+}>;
+/**
+ * Creates a single React provider from an array of existing providers
+ * assuming providers only take "children" as props.
+ *
+ * Prevents the annoying React element nesting
+ * Example here: https://getfrontend.tips/compose-multiple-react-providers/
+ *
+ * The order matters:
+ * - The first provider is at the top of the tree.
+ * - The last provider is the most nested one
+ *
+ * @param providers array of providers to compose
+ */
+export declare function composeProviders(providers: SimpleProvider[]): SimpleProvider;
+export {};
+//# sourceMappingURL=reactUtils.d.ts.map

package/lib/utils/reactUtils.d.ts.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"reactUtils.d.ts","sourceRoot":"","sources":["../../src/utils/reactUtils.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,EAMZ,KAAK,aAAa,EAClB,KAAK,SAAS,EACf,MAAM,OAAO,CAAC;AAGf;;;;;;;GAOG;AACH,eAAO,MAAM,yBAAyB,8BAEzB,CAAC;AAEd;;;;;;;;;;;GAWG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,KAAK,EAAE,KAAK,OAAO,EAC9D,QAAQ,EAAE,CAAC,GACV,CAAC,CAUH;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,GAAG,SAAS,CAQtD;AAED;;;;GAIG;AACH,qBAAa,iBAAkB,SAAQ,KAAK;gBAC9B,YAAY,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM;CAQ1D;AAED;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,CAMhE;AAED,aAAK,cAAc,GAAG,aAAa,CAAC;IAAC,QAAQ,EAAE,SAAS,CAAA;CAAC,CAAC,CAAC;AAE3D;;;;;;;;;;;;GAYG;AACH,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,cAAc,EAAE,GAAG,cAAc,CAY5E"}

package/lib/utils/reactUtils.js ADDED Viewed

@@ -0,0 +1,98 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import React, { useCallback, useEffect, useLayoutEffect, useMemo, useRef, } from 'react';
+import ExecutionEnvironment from '@docusaurus/ExecutionEnvironment';
+/**
+ * This hook is like `useLayoutEffect`, but without the SSR warning.
+ * It seems hacky but it's used in many React libs (Redux, Formik...).
+ * Also mentioned here: https://github.com/facebook/react/issues/16956
+ *
+ * It is useful when you need to update a ref as soon as possible after a React
+ * render (before `useEffect`).
+ */
+export const useIsomorphicLayoutEffect = ExecutionEnvironment.canUseDOM
+    ? useLayoutEffect
+    : useEffect;
+/**
+ * Temporary userland implementation until an official hook is implemented
+ * See RFC: https://github.com/reactjs/rfcs/pull/220
+ *
+ * Permits to transform an unstable callback (like an arrow function provided as
+ * props) to a "stable" callback that is safe to use in a `useEffect` dependency
+ * array. Useful to avoid React stale closure problems + avoid useless effect
+ * re-executions.
+ *
+ * This generally works but has some potential drawbacks, such as
+ * https://github.com/facebook/react/issues/16956#issuecomment-536636418
+ */
+export function useEvent(callback) {
+    const ref = useRef(callback);
+    useIsomorphicLayoutEffect(() => {
+        ref.current = callback;
+    }, [callback]);
+    // @ts-expect-error: TS is right that this callback may be a supertype of T,
+    // but good enough for our use
+    return useCallback((...args) => ref.current(...args), []);
+}
+/**
+ * Gets `value` from the last render.
+ */
+export function usePrevious(value) {
+    const ref = useRef();
+    useIsomorphicLayoutEffect(() => {
+        ref.current = value;
+    });
+    return ref.current;
+}
+/**
+ * This error is thrown when a context is consumed outside its provider. Allows
+ * reusing a generic error message format and reduces bundle size. The hook's
+ * name will be extracted from its stack, so only the provider's name is needed.
+ */
+export class ReactContextError extends Error {
+    constructor(providerName, additionalInfo) {
+        super();
+        this.name = 'ReactContextError';
+        this.message = `Hook ${this.stack?.split('\n')[1]?.match(/at (?:\w+\.)?(?<name>\w+)/)?.groups
+            .name ?? ''} is called outside the <${providerName}>. ${additionalInfo ?? ''}`;
+    }
+}
+/**
+ * Shallow-memoize an object. This means the returned object will be the same as
+ * the previous render if the property keys and values did not change. This
+ * works for simple cases: when property values are primitives or stable
+ * objects.
+ *
+ * @param obj
+ */
+export function useShallowMemoObject(obj) {
+    const deps = Object.entries(obj);
+    // Sort by keys to make it order-insensitive
+    deps.sort((a, b) => a[0].localeCompare(b[0]));
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    return useMemo(() => obj, deps.flat());
+}
+/**
+ * Creates a single React provider from an array of existing providers
+ * assuming providers only take "children" as props.
+ *
+ * Prevents the annoying React element nesting
+ * Example here: https://getfrontend.tips/compose-multiple-react-providers/
+ *
+ * The order matters:
+ * - The first provider is at the top of the tree.
+ * - The last provider is the most nested one
+ *
+ * @param providers array of providers to compose
+ */
+export function composeProviders(providers) {
+    // Creates a single React component: it's cheaper to compose JSX elements
+    return ({ children }) => (<>
+      {providers.reduceRight((element, CurrentProvider) => (<CurrentProvider>{element}</CurrentProvider>), children)}
+    </>);
+}
+//# sourceMappingURL=reactUtils.js.map

package/lib/utils/reactUtils.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"reactUtils.js","sourceRoot":"","sources":["../../src/utils/reactUtils.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,EACZ,WAAW,EACX,SAAS,EACT,eAAe,EACf,OAAO,EACP,MAAM,GAGP,MAAM,OAAO,CAAC;AACf,OAAO,oBAAoB,MAAM,kCAAkC,CAAC;AAEpE;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,oBAAoB,CAAC,SAAS;IACrE,CAAC,CAAC,eAAe;IACjB,CAAC,CAAC,SAAS,CAAC;AAEd;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,QAAQ,CACtB,QAAW;IAEX,MAAM,GAAG,GAAG,MAAM,CAAI,QAAQ,CAAC,CAAC;IAEhC,yBAAyB,CAAC,GAAG,EAAE;QAC7B,GAAG,CAAC,OAAO,GAAG,QAAQ,CAAC;IACzB,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEf,4EAA4E;IAC5E,8BAA8B;IAC9B,OAAO,WAAW,CAAI,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;AAC/D,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,WAAW,CAAI,KAAQ;IACrC,MAAM,GAAG,GAAG,MAAM,EAAK,CAAC;IAExB,yBAAyB,CAAC,GAAG,EAAE;QAC7B,GAAG,CAAC,OAAO,GAAG,KAAK,CAAC;IACtB,CAAC,CAAC,CAAC;IAEH,OAAO,GAAG,CAAC,OAAO,CAAC;AACrB,CAAC;AAED;;;;GAIG;AACH,MAAM,OAAO,iBAAkB,SAAQ,KAAK;IAC1C,YAAY,YAAoB,EAAE,cAAuB;QACvD,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAC;QAChC,IAAI,CAAC,OAAO,GAAG,QACb,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,2BAA2B,CAAC,EAAE,MAAO;aACpE,IAAI,IAAI,EACb,2BAA2B,YAAY,MAAM,cAAc,IAAI,EAAE,EAAE,CAAC;IACtE,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,oBAAoB,CAAmB,GAAM;IAC3D,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACjC,4CAA4C;IAC5C,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9C,uDAAuD;IACvD,OAAO,OAAO,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;AACzC,CAAC;AAID;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,gBAAgB,CAAC,SAA2B;IAC1D,yEAAyE;IACzE,OAAO,CAAC,EAAC,QAAQ,EAAC,EAAE,EAAE,CAAC,CACrB,EACE;MAAA,CAAC,SAAS,CAAC,WAAW,CACpB,CAAC,OAAO,EAAE,eAAe,EAAE,EAAE,CAAC,CAC5B,CAAC,eAAe,CAAC,CAAC,OAAO,CAAC,EAAE,eAAe,CAAC,CAC7C,EACD,QAAQ,CACT,CACH;IAAA,GAAG,CACJ,CAAC;AACJ,CAAC"}

package/lib/utils/regexpUtils.d.ts ADDED Viewed

@@ -0,0 +1,12 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+/**
+ * Matches a string regex (as provided from the config) against a target in a
+ * null-safe fashion, case insensitive and global.
+ */
+export declare function isRegexpStringMatch(regexAsString?: string, valueToTest?: string): boolean;
+//# sourceMappingURL=regexpUtils.d.ts.map

package/lib/utils/regexpUtils.d.ts.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"regexpUtils.d.ts","sourceRoot":"","sources":["../../src/utils/regexpUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;;GAGG;AACH,wBAAgB,mBAAmB,CACjC,aAAa,CAAC,EAAE,MAAM,EACtB,WAAW,CAAC,EAAE,MAAM,GACnB,OAAO,CAST"}

package/lib/utils/regexpUtils.js ADDED Viewed

@@ -0,0 +1,18 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+/**
+ * Matches a string regex (as provided from the config) against a target in a
+ * null-safe fashion, case insensitive and global.
+ */
+export function isRegexpStringMatch(regexAsString, valueToTest) {
+    if (typeof regexAsString === 'undefined' ||
+        typeof valueToTest === 'undefined') {
+        return false;
+    }
+    return new RegExp(regexAsString, 'gi').test(valueToTest);
+}
+//# sourceMappingURL=regexpUtils.js.map

package/lib/utils/regexpUtils.js.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"regexpUtils.js","sourceRoot":"","sources":["../../src/utils/regexpUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CACjC,aAAsB,EACtB,WAAoB;IAEpB,IACE,OAAO,aAAa,KAAK,WAAW;QACpC,OAAO,WAAW,KAAK,WAAW,EAClC;QACA,OAAO,KAAK,CAAC;KACd;IAED,OAAO,IAAI,MAAM,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAC3D,CAAC"}

package/lib/utils/routesUtils.d.ts ADDED Viewed

@@ -0,0 +1,26 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import type { RouteConfig } from 'react-router-config';
+/**
+ * Compare the 2 paths, case insensitive and ignoring trailing slash
+ */
+export declare function isSamePath(path1: string | undefined, path2: string | undefined): boolean;
+/**
+ * Note that sites don't always have a homepage in practice, so we can't assume
+ * that linking to '/' is always safe.
+ * @see https://github.com/facebook/docusaurus/pull/6517#issuecomment-1048709116
+ */
+export declare function findHomePageRoute({ baseUrl, routes: initialRoutes, }: {
+    routes: RouteConfig[];
+    baseUrl: string;
+}): RouteConfig | undefined;
+/**
+ * Fetches the route that points to "/". Use this instead of the naive "/",
+ * because the homepage may not exist.
+ */
+export declare function useHomePageRoute(): RouteConfig | undefined;
+//# sourceMappingURL=routesUtils.d.ts.map

package/lib/utils/routesUtils.d.ts.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"routesUtils.d.ts","sourceRoot":"","sources":["../../src/utils/routesUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAKH,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,qBAAqB,CAAC;AAErD;;GAEG;AACH,wBAAgB,UAAU,CACxB,KAAK,EAAE,MAAM,GAAG,SAAS,EACzB,KAAK,EAAE,MAAM,GAAG,SAAS,GACxB,OAAO,CAOT;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,EAChC,OAAO,EACP,MAAM,EAAE,aAAa,GACtB,EAAE;IACD,MAAM,EAAE,WAAW,EAAE,CAAC;IACtB,OAAO,EAAE,MAAM,CAAC;CACjB,GAAG,WAAW,GAAG,SAAS,CAwB1B;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,IAAI,WAAW,GAAG,SAAS,CAM1D"}

package/lib/utils/routesUtils.js ADDED Viewed

@@ -0,0 +1,54 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { useMemo } from 'react';
+import generatedRoutes from '@generated/routes';
+import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
+/**
+ * Compare the 2 paths, case insensitive and ignoring trailing slash
+ */
+export function isSamePath(path1, path2) {
+    const normalize = (pathname) => (!pathname || pathname.endsWith('/')
+        ? pathname
+        : `${pathname}/`)?.toLowerCase();
+    return normalize(path1) === normalize(path2);
+}
+/**
+ * Note that sites don't always have a homepage in practice, so we can't assume
+ * that linking to '/' is always safe.
+ * @see https://github.com/facebook/docusaurus/pull/6517#issuecomment-1048709116
+ */
+export function findHomePageRoute({ baseUrl, routes: initialRoutes, }) {
+    function isHomePageRoute(route) {
+        return route.path === baseUrl && route.exact === true;
+    }
+    function isHomeParentRoute(route) {
+        return route.path === baseUrl && !route.exact;
+    }
+    function doFindHomePageRoute(routes) {
+        if (routes.length === 0) {
+            return undefined;
+        }
+        const homePage = routes.find(isHomePageRoute);
+        if (homePage) {
+            return homePage;
+        }
+        const indexSubRoutes = routes
+            .filter(isHomeParentRoute)
+            .flatMap((route) => route.routes ?? []);
+        return doFindHomePageRoute(indexSubRoutes);
+    }
+    return doFindHomePageRoute(initialRoutes);
+}
+/**
+ * Fetches the route that points to "/". Use this instead of the naive "/",
+ * because the homepage may not exist.
+ */
+export function useHomePageRoute() {
+    const { baseUrl } = useDocusaurusContext().siteConfig;
+    return useMemo(() => findHomePageRoute({ routes: generatedRoutes, baseUrl }), [baseUrl]);
+}
+//# sourceMappingURL=routesUtils.js.map

package/lib/utils/routesUtils.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"routesUtils.js","sourceRoot":"","sources":["../../src/utils/routesUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAC,OAAO,EAAC,MAAM,OAAO,CAAC;AAC9B,OAAO,eAAe,MAAM,mBAAmB,CAAC;AAChD,OAAO,oBAAoB,MAAM,kCAAkC,CAAC;AAGpE;;GAEG;AACH,MAAM,UAAU,UAAU,CACxB,KAAyB,EACzB,KAAyB;IAEzB,MAAM,SAAS,GAAG,CAAC,QAA4B,EAAE,EAAE,CACjD,CAAC,CAAC,QAAQ,IAAI,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC;QAClC,CAAC,CAAC,QAAQ;QACV,CAAC,CAAC,GAAG,QAAQ,GAAG,CACjB,EAAE,WAAW,EAAE,CAAC;IACnB,OAAO,SAAS,CAAC,KAAK,CAAC,KAAK,SAAS,CAAC,KAAK,CAAC,CAAC;AAC/C,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAAC,EAChC,OAAO,EACP,MAAM,EAAE,aAAa,GAItB;IACC,SAAS,eAAe,CAAC,KAAkB;QACzC,OAAO,KAAK,CAAC,IAAI,KAAK,OAAO,IAAI,KAAK,CAAC,KAAK,KAAK,IAAI,CAAC;IACxD,CAAC;IAED,SAAS,iBAAiB,CAAC,KAAkB;QAC3C,OAAO,KAAK,CAAC,IAAI,KAAK,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC;IAChD,CAAC;IAED,SAAS,mBAAmB,CAAC,MAAqB;QAChD,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;YACvB,OAAO,SAAS,CAAC;SAClB;QACD,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAC9C,IAAI,QAAQ,EAAE;YACZ,OAAO,QAAQ,CAAC;SACjB;QACD,MAAM,cAAc,GAAG,MAAM;aAC1B,MAAM,CAAC,iBAAiB,CAAC;aACzB,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC;QAC1C,OAAO,mBAAmB,CAAC,cAAc,CAAC,CAAC;IAC7C,CAAC;IAED,OAAO,mBAAmB,CAAC,aAAa,CAAC,CAAC;AAC5C,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,gBAAgB;IAC9B,MAAM,EAAC,OAAO,EAAC,GAAG,oBAAoB,EAAE,CAAC,UAAU,CAAC;IACpD,OAAO,OAAO,CACZ,GAAG,EAAE,CAAC,iBAAiB,CAAC,EAAC,MAAM,EAAE,eAAe,EAAE,OAAO,EAAC,CAAC,EAC3D,CAAC,OAAO,CAAC,CACV,CAAC;AACJ,CAAC"}

package/lib/utils/scrollUtils.d.ts ADDED Viewed

@@ -0,0 +1,83 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import React, { type ReactNode } from 'react';
+declare type ScrollController = {
+    /** A boolean ref tracking whether scroll events are enabled. */
+    scrollEventsEnabledRef: React.MutableRefObject<boolean>;
+    /** Enable scroll events in `useScrollPosition`. */
+    enableScrollEvents: () => void;
+    /** Disable scroll events in `useScrollPosition`. */
+    disableScrollEvents: () => void;
+};
+export declare function ScrollControllerProvider({ children, }: {
+    children: ReactNode;
+}): JSX.Element;
+/**
+ * We need a way to update the scroll position while ignoring scroll events
+ * so as not to toggle Navbar/BackToTop visibility.
+ *
+ * This API permits to temporarily disable/ignore scroll events. Motivated by
+ * https://github.com/facebook/docusaurus/pull/5618
+ */
+export declare function useScrollController(): ScrollController;
+declare type ScrollPosition = {
+    scrollX: number;
+    scrollY: number;
+};
+/**
+ * This hook fires an effect when the scroll position changes. The effect will
+ * be provided with the before/after scroll positions. Note that the effect may
+ * not be always run: if scrolling is disabled through `useScrollController`, it
+ * will be a no-op.
+ *
+ * @see {@link useScrollController}
+ */
+export declare function useScrollPosition(effect: (position: ScrollPosition, lastPosition: ScrollPosition | null) => void, deps?: unknown[]): void;
+/**
+ * This hook permits to "block" the scroll position of a DOM element.
+ * The idea is that we should be able to update DOM content above this element
+ * but the screen position of this element should not change.
+ *
+ * Feature motivated by the Tabs groups: clicking on a tab may affect tabs of
+ * the same group upper in the tree, yet to avoid a bad UX, the clicked tab must
+ * remain under the user mouse.
+ *
+ * @see https://github.com/facebook/docusaurus/pull/5618
+ */
+export declare function useScrollPositionBlocker(): {
+    /**
+     * Takes an element, and keeps its screen position no matter what's getting
+     * rendered above it, until the next render.
+     */
+    blockElementScrollPositionUntilNextRender: (el: HTMLElement) => void;
+};
+declare type CancelScrollTop = () => void;
+/**
+ * A "smart polyfill" of `window.scrollTo({ top, behavior: "smooth" })`.
+ * This currently always uses a polyfilled implementation unless
+ * `scroll-behavior: smooth` has been set in CSS, because native support
+ * detection for scroll behavior seems unreliable.
+ *
+ * This hook does not do anything by itself: it returns a start and a stop
+ * handle. You can execute either handle at any time.
+ */
+export declare function useSmoothScrollTo(): {
+    /**
+     * Start the scroll.
+     *
+     * @param top The final scroll top position.
+     */
+    startScroll: (top: number) => void;
+    /**
+     * A cancel function, because the non-native smooth scroll-top
+     * implementation must be interrupted if user scrolls down. If there's no
+     * existing animation or the scroll is using native behavior, this is a no-op.
+     */
+    cancelScroll: CancelScrollTop;
+};
+export {};
+//# sourceMappingURL=scrollUtils.d.ts.map

package/lib/utils/scrollUtils.d.ts.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"scrollUtils.d.ts","sourceRoot":"","sources":["../../src/utils/scrollUtils.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,EAOZ,KAAK,SAAS,EACf,MAAM,OAAO,CAAC;AAKf,aAAK,gBAAgB,GAAG;IACtB,gEAAgE;IAChE,sBAAsB,EAAE,KAAK,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACxD,mDAAmD;IACnD,kBAAkB,EAAE,MAAM,IAAI,CAAC;IAC/B,oDAAoD;IACpD,mBAAmB,EAAE,MAAM,IAAI,CAAC;CACjC,CAAC;AAuBF,wBAAgB,wBAAwB,CAAC,EACvC,QAAQ,GACT,EAAE;IACD,QAAQ,EAAE,SAAS,CAAC;CACrB,GAAG,GAAG,CAAC,OAAO,CAOd;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,IAAI,gBAAgB,CAMtD;AAED,aAAK,cAAc,GAAG;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAC,CAAC;AAUzD;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,CACN,QAAQ,EAAE,cAAc,EACxB,YAAY,EAAE,cAAc,GAAG,IAAI,KAChC,IAAI,EACT,IAAI,GAAE,OAAO,EAAO,GACnB,IAAI,CA0BN;AA6CD;;;;;;;;;;GAUG;AACH,wBAAgB,wBAAwB,IAAI;IAC1C;;;OAGG;IACH,yCAAyC,EAAE,CAAC,EAAE,EAAE,WAAW,KAAK,IAAI,CAAC;CACtE,CAwCA;AAED,aAAK,eAAe,GAAG,MAAM,IAAI,CAAC;AA6BlC;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,IAAI;IACnC;;;;OAIG;IACH,WAAW,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;IACnC;;;;OAIG;IACH,YAAY,EAAE,eAAe,CAAC;CAC/B,CAoBA"}