@docusaurus/theme-common 2.0.0-beta.17 → 2.0.0-beta.18

package/lib/contexts/docsPreferredVersion.js

@@ -0,0 +1,125 @@
+/**
+ * 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, { useContext, useEffect, useMemo, useState, useCallback, } from 'react';
+import { useThemeConfig, } from '../utils/useThemeConfig';
+import { isDocsPluginEnabled } from '../utils/docsUtils';
+import { ReactContextError } from '../utils/reactUtils';
+import { createStorageSlot } from '../utils/storageUtils';
+import { useAllDocsData, useDocsData, } from '@docusaurus/plugin-content-docs/client';
+import { DEFAULT_PLUGIN_ID } from '@docusaurus/constants';
+const storageKey = (pluginId) => `docs-preferred-version-${pluginId}`;
+const DocsPreferredVersionStorage = {
+    save: (pluginId, persistence, versionName) => {
+        createStorageSlot(storageKey(pluginId), { persistence }).set(versionName);
+    },
+    read: (pluginId, persistence) => createStorageSlot(storageKey(pluginId), { persistence }).get(),
+    clear: (pluginId, persistence) => {
+        createStorageSlot(storageKey(pluginId), { persistence }).del();
+    },
+};
+/**
+ * Initial state is always null as we can't read local storage from node SSR
+ */
+const getInitialState = (pluginIds) => Object.fromEntries(pluginIds.map((id) => [id, { preferredVersionName: null }]));
+/**
+ * Read storage for all docs plugins, assigning each doc plugin a preferred
+ * version (if found)
+ */
+function readStorageState({ pluginIds, versionPersistence, allDocsData, }) {
+    /**
+     * The storage value we read might be stale, and belong to a version that does
+     * not exist in the site anymore. In such case, we remove the storage value to
+     * avoid downstream errors.
+     */
+    function restorePluginState(pluginId) {
+        const preferredVersionNameUnsafe = DocsPreferredVersionStorage.read(pluginId, versionPersistence);
+        const pluginData = allDocsData[pluginId];
+        const versionExists = pluginData.versions.some((version) => version.name === preferredVersionNameUnsafe);
+        if (versionExists) {
+            return { preferredVersionName: preferredVersionNameUnsafe };
+        }
+        DocsPreferredVersionStorage.clear(pluginId, versionPersistence);
+        return { preferredVersionName: null };
+    }
+    return Object.fromEntries(pluginIds.map((id) => [id, restorePluginState(id)]));
+}
+function useVersionPersistence() {
+    return useThemeConfig().docs.versionPersistence;
+}
+const Context = React.createContext(null);
+function useContextValue() {
+    const allDocsData = useAllDocsData();
+    const versionPersistence = useVersionPersistence();
+    const pluginIds = useMemo(() => Object.keys(allDocsData), [allDocsData]);
+    // Initial state is empty, as we can't read browser storage in node/SSR
+    const [state, setState] = useState(() => getInitialState(pluginIds));
+    // On mount, we set the state read from browser storage
+    useEffect(() => {
+        setState(readStorageState({ allDocsData, versionPersistence, pluginIds }));
+    }, [allDocsData, versionPersistence, pluginIds]);
+    // The API that we expose to consumer hooks (memo for constant object)
+    const api = useMemo(() => {
+        function savePreferredVersion(pluginId, versionName) {
+            DocsPreferredVersionStorage.save(pluginId, versionPersistence, versionName);
+            setState((s) => ({
+                ...s,
+                [pluginId]: { preferredVersionName: versionName },
+            }));
+        }
+        return {
+            savePreferredVersion,
+        };
+    }, [versionPersistence]);
+    return [state, api];
+}
+function DocsPreferredVersionContextProviderUnsafe({ children, }) {
+    const value = useContextValue();
+    return React.createElement(Context.Provider, { value: value }, children);
+}
+/**
+ * This is a maybe-layer. If the docs plugin is not enabled, this provider is a
+ * simple pass-through.
+ */
+export function DocsPreferredVersionContextProvider({ children, }) {
+    if (isDocsPluginEnabled) {
+        return (React.createElement(DocsPreferredVersionContextProviderUnsafe, null, children));
+    }
+    return children;
+}
+function useDocsPreferredVersionContext() {
+    const value = useContext(Context);
+    if (!value) {
+        throw new ReactContextError('DocsPreferredVersionContextProvider');
+    }
+    return value;
+}
+/**
+ * Returns a read-write interface to a plugin's preferred version.
+ * Note, the `preferredVersion` attribute will always be `null` before mount.
+ */
+export function useDocsPreferredVersion(pluginId = DEFAULT_PLUGIN_ID) {
+    const docsData = useDocsData(pluginId);
+    const [state, api] = useDocsPreferredVersionContext();
+    const { preferredVersionName } = state[pluginId];
+    const preferredVersion = docsData.versions.find((version) => version.name === preferredVersionName) ?? null;
+    const savePreferredVersionName = useCallback((versionName) => {
+        api.savePreferredVersion(pluginId, versionName);
+    }, [api, pluginId]);
+    return { preferredVersion, savePreferredVersionName };
+}
+export function useDocsPreferredVersionByPluginId() {
+    const allDocsData = useAllDocsData();
+    const [state] = useDocsPreferredVersionContext();
+    function getPluginIdPreferredVersion(pluginId) {
+        const docsData = allDocsData[pluginId];
+        const { preferredVersionName } = state[pluginId];
+        return (docsData.versions.find((version) => version.name === preferredVersionName) ?? null);
+    }
+    const pluginIds = Object.keys(allDocsData);
+    return Object.fromEntries(pluginIds.map((id) => [id, getPluginIdPreferredVersion(id)]));
+}
+//# sourceMappingURL=docsPreferredVersion.js.map

package/lib/contexts/docsPreferredVersion.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"docsPreferredVersion.js","sourceRoot":"","sources":["../../src/contexts/docsPreferredVersion.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,EACZ,UAAU,EACV,SAAS,EACT,OAAO,EACP,QAAQ,EACR,WAAW,GAEZ,MAAM,OAAO,CAAC;AACf,OAAO,EACL,cAAc,GAEf,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAC,mBAAmB,EAAC,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAAC,iBAAiB,EAAC,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAC,iBAAiB,EAAC,MAAM,uBAAuB,CAAC;AAExD,OAAO,EACL,cAAc,EACd,WAAW,GAGZ,MAAM,wCAAwC,CAAC;AAEhD,OAAO,EAAC,iBAAiB,EAAC,MAAM,uBAAuB,CAAC;AAExD,MAAM,UAAU,GAAG,CAAC,QAAgB,EAAE,EAAE,CAAC,0BAA0B,QAAQ,EAAE,CAAC;AAE9E,MAAM,2BAA2B,GAAG;IAClC,IAAI,EAAE,CACJ,QAAgB,EAChB,WAAmC,EACnC,WAAmB,EACb,EAAE;QACR,iBAAiB,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,EAAC,WAAW,EAAC,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAC1E,CAAC;IAED,IAAI,EAAE,CACJ,QAAgB,EAChB,WAAmC,EACpB,EAAE,CACjB,iBAAiB,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,EAAC,WAAW,EAAC,CAAC,CAAC,GAAG,EAAE;IAE9D,KAAK,EAAE,CAAC,QAAgB,EAAE,WAAmC,EAAQ,EAAE;QACrE,iBAAiB,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,EAAC,WAAW,EAAC,CAAC,CAAC,GAAG,EAAE,CAAC;IAC/D,CAAC;CACF,CAAC;AAiBF;;GAEG;AACH,MAAM,eAAe,GAAG,CAAC,SAAmB,EAA6B,EAAE,CACzE,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,EAAC,oBAAoB,EAAE,IAAI,EAAC,CAAC,CAAC,CAAC,CAAC;AAEhF;;;GAGG;AACH,SAAS,gBAAgB,CAAC,EACxB,SAAS,EACT,kBAAkB,EAClB,WAAW,GAKZ;IACC;;;;OAIG;IACH,SAAS,kBAAkB,CACzB,QAAgB;QAEhB,MAAM,0BAA0B,GAAG,2BAA2B,CAAC,IAAI,CACjE,QAAQ,EACR,kBAAkB,CACnB,CAAC;QACF,MAAM,UAAU,GAAG,WAAW,CAAC,QAAQ,CAAE,CAAC;QAC1C,MAAM,aAAa,GAAG,UAAU,CAAC,QAAQ,CAAC,IAAI,CAC5C,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,0BAA0B,CACzD,CAAC;QACF,IAAI,aAAa,EAAE;YACjB,OAAO,EAAC,oBAAoB,EAAE,0BAA0B,EAAC,CAAC;SAC3D;QACD,2BAA2B,CAAC,KAAK,CAAC,QAAQ,EAAE,kBAAkB,CAAC,CAAC;QAChE,OAAO,EAAC,oBAAoB,EAAE,IAAI,EAAC,CAAC;IACtC,CAAC;IACD,OAAO,MAAM,CAAC,WAAW,CACvB,SAAS,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,kBAAkB,CAAC,EAAE,CAAC,CAAC,CAAC,CACpD,CAAC;AACJ,CAAC;AAED,SAAS,qBAAqB;IAC5B,OAAO,cAAc,EAAE,CAAC,IAAI,CAAC,kBAAkB,CAAC;AAClD,CAAC;AASD,MAAM,OAAO,GAAG,KAAK,CAAC,aAAa,CAAsB,IAAI,CAAC,CAAC;AAE/D,SAAS,eAAe;IACtB,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;IACrC,MAAM,kBAAkB,GAAG,qBAAqB,EAAE,CAAC;IACnD,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;IAEzE,uEAAuE;IACvE,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,CAAC,GAAG,EAAE,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC;IAErE,uDAAuD;IACvD,SAAS,CAAC,GAAG,EAAE;QACb,QAAQ,CAAC,gBAAgB,CAAC,EAAC,WAAW,EAAE,kBAAkB,EAAE,SAAS,EAAC,CAAC,CAAC,CAAC;IAC3E,CAAC,EAAE,CAAC,WAAW,EAAE,kBAAkB,EAAE,SAAS,CAAC,CAAC,CAAC;IAEjD,sEAAsE;IACtE,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE;QACvB,SAAS,oBAAoB,CAAC,QAAgB,EAAE,WAAmB;YACjE,2BAA2B,CAAC,IAAI,CAC9B,QAAQ,EACR,kBAAkB,EAClB,WAAW,CACZ,CAAC;YACF,QAAQ,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;gBACf,GAAG,CAAC;gBACJ,CAAC,QAAQ,CAAC,EAAE,EAAC,oBAAoB,EAAE,WAAW,EAAC;aAChD,CAAC,CAAC,CAAC;QACN,CAAC;QAED,OAAO;YACL,oBAAoB;SACrB,CAAC;IACJ,CAAC,EAAE,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAEzB,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;AACtB,CAAC;AAED,SAAS,yCAAyC,CAAC,EACjD,QAAQ,GAGT;IACC,MAAM,KAAK,GAAG,eAAe,EAAE,CAAC;IAChC,OAAO,oBAAC,OAAO,CAAC,QAAQ,IAAC,KAAK,EAAE,KAAK,IAAG,QAAQ,CAAoB,CAAC;AACvE,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,mCAAmC,CAAC,EAClD,QAAQ,GAGT;IACC,IAAI,mBAAmB,EAAE;QACvB,OAAO,CACL,oBAAC,yCAAyC,QACvC,QAAQ,CACiC,CAC7C,CAAC;KACH;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,8BAA8B;IACrC,MAAM,KAAK,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IAClC,IAAI,CAAC,KAAK,EAAE;QACV,MAAM,IAAI,iBAAiB,CAAC,qCAAqC,CAAC,CAAC;KACpE;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,uBAAuB,CACrC,WAA+B,iBAAiB;IAKhD,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC;IACvC,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,GAAG,8BAA8B,EAAE,CAAC;IAEtD,MAAM,EAAC,oBAAoB,EAAC,GAAG,KAAK,CAAC,QAAQ,CAAE,CAAC;IAEhD,MAAM,gBAAgB,GACpB,QAAQ,CAAC,QAAQ,CAAC,IAAI,CACpB,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,oBAAoB,CACnD,IAAI,IAAI,CAAC;IAEZ,MAAM,wBAAwB,GAAG,WAAW,CAC1C,CAAC,WAAmB,EAAE,EAAE;QACtB,GAAG,CAAC,oBAAoB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IAClD,CAAC,EACD,CAAC,GAAG,EAAE,QAAQ,CAAC,CAChB,CAAC;IAEF,OAAO,EAAC,gBAAgB,EAAE,wBAAwB,EAAC,CAAC;AACtD,CAAC;AAED,MAAM,UAAU,iCAAiC;IAG/C,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;IACrC,MAAM,CAAC,KAAK,CAAC,GAAG,8BAA8B,EAAE,CAAC;IAEjD,SAAS,2BAA2B,CAAC,QAAgB;QACnD,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAE,CAAC;QACxC,MAAM,EAAC,oBAAoB,EAAC,GAAG,KAAK,CAAC,QAAQ,CAAE,CAAC;QAEhD,OAAO,CACL,QAAQ,CAAC,QAAQ,CAAC,IAAI,CACpB,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,oBAAoB,CACnD,IAAI,IAAI,CACV,CAAC;IACJ,CAAC;IACD,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAC3C,OAAO,MAAM,CAAC,WAAW,CACvB,SAAS,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,2BAA2B,CAAC,EAAE,CAAC,CAAC,CAAC,CAC7D,CAAC;AACJ,CAAC"}

package/lib/contexts/docsSidebar.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 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';
+import type { PropSidebar } from '@docusaurus/plugin-content-docs';
+/**
+ * Provide the current sidebar to your children.
+ */
+export declare function DocsSidebarProvider({ children, sidebar, }: {
+    children: ReactNode;
+    sidebar: PropSidebar | null;
+}): JSX.Element;
+/**
+ * Gets the sidebar that's currently displayed, or `null` if there isn't one
+ */
+export declare function useDocsSidebar(): PropSidebar | null;
+//# sourceMappingURL=docsSidebar.d.ts.map

package/lib/contexts/docsSidebar.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"docsSidebar.d.ts","sourceRoot":"","sources":["../../src/contexts/docsSidebar.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAc,EAAC,KAAK,SAAS,EAAa,MAAM,OAAO,CAAC;AACxD,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,iCAAiC,CAAC;AAWjE;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,EAClC,QAAQ,EACR,OAAO,GACR,EAAE;IACD,QAAQ,EAAE,SAAS,CAAC;IACpB,OAAO,EAAE,WAAW,GAAG,IAAI,CAAC;CAC7B,GAAG,GAAG,CAAC,OAAO,CAEd;AAED;;GAEG;AACH,wBAAgB,cAAc,IAAI,WAAW,GAAG,IAAI,CAMnD"}

package/lib/contexts/docsSidebar.js

@@ -0,0 +1,29 @@
+/**
+ * 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, { useContext } from 'react';
+import { ReactContextError } from '../utils/reactUtils';
+// Using a Symbol because null is a valid context value (a doc with no sidebar)
+// Inspired by https://github.com/jamiebuilds/unstated-next/blob/master/src/unstated-next.tsx
+const EmptyContext = Symbol('EmptyContext');
+const Context = React.createContext(EmptyContext);
+/**
+ * Provide the current sidebar to your children.
+ */
+export function DocsSidebarProvider({ children, sidebar, }) {
+    return React.createElement(Context.Provider, { value: sidebar }, children);
+}
+/**
+ * Gets the sidebar that's currently displayed, or `null` if there isn't one
+ */
+export function useDocsSidebar() {
+    const sidebar = useContext(Context);
+    if (sidebar === EmptyContext) {
+        throw new ReactContextError('DocsSidebarProvider');
+    }
+    return sidebar;
+}
+//# sourceMappingURL=docsSidebar.js.map

package/lib/contexts/docsSidebar.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"docsSidebar.js","sourceRoot":"","sources":["../../src/contexts/docsSidebar.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,EAAiB,UAAU,EAAC,MAAM,OAAO,CAAC;AAExD,OAAO,EAAC,iBAAiB,EAAC,MAAM,qBAAqB,CAAC;AAEtD,+EAA+E;AAC/E,6FAA6F;AAC7F,MAAM,YAAY,GAAkB,MAAM,CAAC,cAAc,CAAC,CAAC;AAE3D,MAAM,OAAO,GAAG,KAAK,CAAC,aAAa,CACjC,YAAY,CACb,CAAC;AAEF;;GAEG;AACH,MAAM,UAAU,mBAAmB,CAAC,EAClC,QAAQ,EACR,OAAO,GAIR;IACC,OAAO,oBAAC,OAAO,CAAC,QAAQ,IAAC,KAAK,EAAE,OAAO,IAAG,QAAQ,CAAoB,CAAC;AACzE,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,cAAc;IAC5B,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IACpC,IAAI,OAAO,KAAK,YAAY,EAAE;QAC5B,MAAM,IAAI,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;KACpD;IACD,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/lib/contexts/docsVersion.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 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';
+import type { PropVersionMetadata } from '@docusaurus/plugin-content-docs';
+/**
+ * Provide the current version's metadata to your children.
+ */
+export declare function DocsVersionProvider({ children, version, }: {
+    children: ReactNode;
+    version: PropVersionMetadata | null;
+}): JSX.Element;
+/**
+ * Gets the version metadata of the current doc page.
+ */
+export declare function useDocsVersion(): PropVersionMetadata;
+//# sourceMappingURL=docsVersion.d.ts.map

package/lib/contexts/docsVersion.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"docsVersion.d.ts","sourceRoot":"","sources":["../../src/contexts/docsVersion.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAc,EAAC,KAAK,SAAS,EAAa,MAAM,OAAO,CAAC;AACxD,OAAO,KAAK,EAAC,mBAAmB,EAAC,MAAM,iCAAiC,CAAC;AAKzE;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,EAClC,QAAQ,EACR,OAAO,GACR,EAAE;IACD,QAAQ,EAAE,SAAS,CAAC;IACpB,OAAO,EAAE,mBAAmB,GAAG,IAAI,CAAC;CACrC,GAAG,GAAG,CAAC,OAAO,CAEd;AAED;;GAEG;AACH,wBAAgB,cAAc,IAAI,mBAAmB,CAMpD"}

package/lib/contexts/docsVersion.js

@@ -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 React, { useContext } from 'react';
+import { ReactContextError } from '../utils/reactUtils';
+const Context = React.createContext(null);
+/**
+ * Provide the current version's metadata to your children.
+ */
+export function DocsVersionProvider({ children, version, }) {
+    return React.createElement(Context.Provider, { value: version }, children);
+}
+/**
+ * Gets the version metadata of the current doc page.
+ */
+export function useDocsVersion() {
+    const version = useContext(Context);
+    if (version === null) {
+        throw new ReactContextError('DocsVersionProvider');
+    }
+    return version;
+}
+//# sourceMappingURL=docsVersion.js.map

package/lib/contexts/docsVersion.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"docsVersion.js","sourceRoot":"","sources":["../../src/contexts/docsVersion.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,EAAiB,UAAU,EAAC,MAAM,OAAO,CAAC;AAExD,OAAO,EAAC,iBAAiB,EAAC,MAAM,qBAAqB,CAAC;AAEtD,MAAM,OAAO,GAAG,KAAK,CAAC,aAAa,CAA6B,IAAI,CAAC,CAAC;AAEtE;;GAEG;AACH,MAAM,UAAU,mBAAmB,CAAC,EAClC,QAAQ,EACR,OAAO,GAIR;IACC,OAAO,oBAAC,OAAO,CAAC,QAAQ,IAAC,KAAK,EAAE,OAAO,IAAG,QAAQ,CAAoB,CAAC;AACzE,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,cAAc;IAC5B,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IACpC,IAAI,OAAO,KAAK,IAAI,EAAE;QACpB,MAAM,IAAI,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;KACpD;IACD,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/lib/contexts/navbarMobileSidebar.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 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';
+declare type ContextValue = {
+    /**
+     * Mobile sidebar should be disabled in case it's empty, i.e. no secondary
+     * menu + no navbar items). If disabled, the toggle button should not be
+     * displayed at all.
+     */
+    disabled: boolean;
+    /**
+     * Signals whether the actual sidebar should be displayed (contrary to
+     * `disabled` which is about the toggle button). Sidebar should not visible
+     * until user interaction to avoid SSR rendering.
+     */
+    shouldRender: boolean;
+    /** The displayed state. Can be toggled with the `toggle` callback. */
+    shown: boolean;
+    /** Toggle the `shown` attribute. */
+    toggle: () => void;
+};
+export declare function NavbarMobileSidebarProvider({ children, }: {
+    children: ReactNode;
+}): JSX.Element;
+export declare function useNavbarMobileSidebar(): ContextValue;
+export {};
+//# sourceMappingURL=navbarMobileSidebar.d.ts.map

package/lib/contexts/navbarMobileSidebar.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"navbarMobileSidebar.d.ts","sourceRoot":"","sources":["../../src/contexts/navbarMobileSidebar.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAc,EAKZ,KAAK,SAAS,EACf,MAAM,OAAO,CAAC;AAOf,aAAK,YAAY,GAAG;IAClB;;;;OAIG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB;;;;OAIG;IACH,YAAY,EAAE,OAAO,CAAC;IACtB,sEAAsE;IACtE,KAAK,EAAE,OAAO,CAAC;IACf,oCAAoC;IACpC,MAAM,EAAE,MAAM,IAAI,CAAC;CACpB,CAAC;AA8CF,wBAAgB,2BAA2B,CAAC,EAC1C,QAAQ,GACT,EAAE;IACD,QAAQ,EAAE,SAAS,CAAC;CACrB,GAAG,GAAG,CAAC,OAAO,CAGd;AAED,wBAAgB,sBAAsB,IAAI,YAAY,CAMrD"}

package/lib/contexts/navbarMobileSidebar.js

@@ -0,0 +1,56 @@
+/**
+ * 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, useState, useMemo, } from 'react';
+import { useWindowSize } from '../hooks/useWindowSize';
+import { useHistoryPopHandler } from '../utils/historyUtils';
+import { useActivePlugin } from '@docusaurus/plugin-content-docs/client';
+import { useThemeConfig } from '../utils/useThemeConfig';
+import { ReactContextError } from '../utils/reactUtils';
+const Context = React.createContext(undefined);
+function useIsNavbarMobileSidebarDisabled() {
+    const activeDocPlugin = useActivePlugin();
+    const { items } = useThemeConfig().navbar;
+    return items.length === 0 && !activeDocPlugin;
+}
+function useContextValue() {
+    const disabled = useIsNavbarMobileSidebarDisabled();
+    const windowSize = useWindowSize();
+    const shouldRender = !disabled && windowSize === 'mobile';
+    const [shown, setShown] = useState(false);
+    // Close mobile sidebar on navigation pop
+    // Most likely firing when using the Android back button (but not only)
+    useHistoryPopHandler(() => {
+        if (shown) {
+            setShown(false);
+            // Should we prevent the navigation here?
+            // See https://github.com/facebook/docusaurus/pull/5462#issuecomment-911699846
+            return false; // prevent pop navigation
+        }
+        return undefined;
+    });
+    const toggle = useCallback(() => {
+        setShown((s) => !s);
+    }, []);
+    useEffect(() => {
+        if (windowSize === 'desktop') {
+            setShown(false);
+        }
+    }, [windowSize]);
+    return useMemo(() => ({ disabled, shouldRender, toggle, shown }), [disabled, shouldRender, toggle, shown]);
+}
+export function NavbarMobileSidebarProvider({ children, }) {
+    const value = useContextValue();
+    return React.createElement(Context.Provider, { value: value }, children);
+}
+export function useNavbarMobileSidebar() {
+    const context = React.useContext(Context);
+    if (context === undefined) {
+        throw new ReactContextError('NavbarMobileSidebarProvider');
+    }
+    return context;
+}
+//# sourceMappingURL=navbarMobileSidebar.js.map

package/lib/contexts/navbarMobileSidebar.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"navbarMobileSidebar.js","sourceRoot":"","sources":["../../src/contexts/navbarMobileSidebar.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,EACZ,WAAW,EACX,SAAS,EACT,QAAQ,EACR,OAAO,GAER,MAAM,OAAO,CAAC;AACf,OAAO,EAAC,aAAa,EAAC,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAC,oBAAoB,EAAC,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EAAC,eAAe,EAAC,MAAM,wCAAwC,CAAC;AACvE,OAAO,EAAC,cAAc,EAAC,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAC,iBAAiB,EAAC,MAAM,qBAAqB,CAAC;AAqBtD,MAAM,OAAO,GAAG,KAAK,CAAC,aAAa,CAA2B,SAAS,CAAC,CAAC;AAEzE,SAAS,gCAAgC;IACvC,MAAM,eAAe,GAAG,eAAe,EAAE,CAAC;IAC1C,MAAM,EAAC,KAAK,EAAC,GAAG,cAAc,EAAE,CAAC,MAAM,CAAC;IACxC,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC;AAChD,CAAC;AAED,SAAS,eAAe;IACtB,MAAM,QAAQ,GAAG,gCAAgC,EAAE,CAAC;IACpD,MAAM,UAAU,GAAG,aAAa,EAAE,CAAC;IAEnC,MAAM,YAAY,GAAG,CAAC,QAAQ,IAAI,UAAU,KAAK,QAAQ,CAAC;IAE1D,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IAE1C,yCAAyC;IACzC,uEAAuE;IACvE,oBAAoB,CAAC,GAAG,EAAE;QACxB,IAAI,KAAK,EAAE;YACT,QAAQ,CAAC,KAAK,CAAC,CAAC;YAChB,yCAAyC;YACzC,8EAA8E;YAC9E,OAAO,KAAK,CAAC,CAAC,yBAAyB;SACxC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,WAAW,CAAC,GAAG,EAAE;QAC9B,QAAQ,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IACtB,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,UAAU,KAAK,SAAS,EAAE;YAC5B,QAAQ,CAAC,KAAK,CAAC,CAAC;SACjB;IACH,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;IAEjB,OAAO,OAAO,CACZ,GAAG,EAAE,CAAC,CAAC,EAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,KAAK,EAAC,CAAC,EAC/C,CAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,KAAK,CAAC,CACxC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,2BAA2B,CAAC,EAC1C,QAAQ,GAGT;IACC,MAAM,KAAK,GAAG,eAAe,EAAE,CAAC;IAChC,OAAO,oBAAC,OAAO,CAAC,QAAQ,IAAC,KAAK,EAAE,KAAK,IAAG,QAAQ,CAAoB,CAAC;AACvE,CAAC;AAED,MAAM,UAAU,sBAAsB;IACpC,MAAM,OAAO,GAAG,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAC1C,IAAI,OAAO,KAAK,SAAS,EAAE;QACzB,MAAM,IAAI,iBAAiB,CAAC,6BAA6B,CAAC,CAAC;KAC5D;IACD,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/lib/contexts/navbarSecondaryMenu.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 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, type ComponentType } from 'react';
+export declare type NavbarSecondaryMenuComponent<Props> = ComponentType<Props>;
+export declare function NavbarSecondaryMenuProvider({ children, }: {
+    children: ReactNode;
+}): JSX.Element;
+/**
+ * This component renders nothing by itself, but it fills the placeholder in the
+ * generic secondary menu layout. This reduces coupling between the main layout
+ * and the specific page.
+ *
+ * This kind of feature is often called portal/teleport/gateway/outlet...
+ * Various unmaintained React libs exist. Most up-to-date one:
+ * https://github.com/gregberge/react-teleporter
+ * Not sure any of those is safe regarding concurrent mode.
+ */
+export declare function NavbarSecondaryMenuFiller<P extends object>({ component, props, }: {
+    component: NavbarSecondaryMenuComponent<P>;
+    props: P;
+}): JSX.Element | null;
+/** Wires the logic for rendering the mobile navbar secondary menu. */
+export declare function useNavbarSecondaryMenu(): {
+    /** Whether secondary menu is displayed. */
+    shown: boolean;
+    /**
+     * Hide the secondary menu; fired either when hiding the entire sidebar, or
+     * when going back to the primary menu.
+     */
+    hide: () => void;
+    /** The content returned from the current secondary menu filler. */
+    content: JSX.Element | undefined;
+};
+//# sourceMappingURL=navbarSecondaryMenu.d.ts.map

package/lib/contexts/navbarSecondaryMenu.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"navbarSecondaryMenu.d.ts","sourceRoot":"","sources":["../../src/contexts/navbarSecondaryMenu.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAc,EAMZ,KAAK,SAAS,EACd,KAAK,aAAa,EACnB,MAAM,OAAO,CAAC;AAIf,oBAAY,4BAA4B,CAAC,KAAK,IAAI,aAAa,CAAC,KAAK,CAAC,CAAC;AA0DvE,wBAAgB,2BAA2B,CAAC,EAC1C,QAAQ,GACT,EAAE;IACD,QAAQ,EAAE,SAAS,CAAC;CACrB,GAAG,GAAG,CAAC,OAAO,CAGd;AAmBD;;;;;;;;;GASG;AACH,wBAAgB,yBAAyB,CAAC,CAAC,SAAS,MAAM,EAAE,EAC1D,SAAS,EACT,KAAK,GACN,EAAE;IACD,SAAS,EAAE,4BAA4B,CAAC,CAAC,CAAC,CAAC;IAC3C,KAAK,EAAE,CAAC,CAAC;CACV,GAAG,GAAG,CAAC,OAAO,GAAG,IAAI,CAiBrB;AAUD,sEAAsE;AACtE,wBAAgB,sBAAsB,IAAI;IACxC,2CAA2C;IAC3C,KAAK,EAAE,OAAO,CAAC;IACf;;;OAGG;IACH,IAAI,EAAE,MAAM,IAAI,CAAC;IACjB,mEAAmE;IACnE,OAAO,EAAE,GAAG,CAAC,OAAO,GAAG,SAAS,CAAC;CAClC,CAYA"}

package/lib/contexts/navbarSecondaryMenu.js

@@ -0,0 +1,93 @@
+/**
+ * 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, { useState, useContext, useEffect, useMemo, useCallback, } from 'react';
+import { ReactContextError, usePrevious } from '../utils/reactUtils';
+import { useNavbarMobileSidebar } from './navbarMobileSidebar';
+const InitialState = {
+    shown: false,
+    content: { component: null, props: null },
+};
+const Context = React.createContext(null);
+function useContextValue() {
+    const mobileSidebar = useNavbarMobileSidebar();
+    const [state, setState] = useState(InitialState);
+    const setShown = (shown) => setState((s) => ({ ...s, shown }));
+    const hasContent = state.content?.component !== null;
+    const previousHasContent = usePrevious(state.content?.component !== null);
+    // When content is become available for the first time (set in useEffect)
+    // we set this content to be shown!
+    useEffect(() => {
+        const contentBecameAvailable = hasContent && !previousHasContent;
+        if (contentBecameAvailable) {
+            setShown(true);
+        }
+    }, [hasContent, previousHasContent]);
+    // On sidebar close, secondary menu is set to be shown on next re-opening
+    // (if any secondary menu content available)
+    useEffect(() => {
+        if (!hasContent) {
+            setShown(false);
+            return;
+        }
+        if (!mobileSidebar.shown) {
+            setShown(true);
+        }
+    }, [mobileSidebar.shown, hasContent]);
+    return [state, setState];
+}
+export function NavbarSecondaryMenuProvider({ children, }) {
+    const value = useContextValue();
+    return React.createElement(Context.Provider, { value: value }, children);
+}
+function useNavbarSecondaryMenuContext() {
+    const value = useContext(Context);
+    if (value === null) {
+        throw new ReactContextError('MobileSecondaryMenuProvider');
+    }
+    return value;
+}
+function useShallowMemoizedObject(obj) {
+    return useMemo(() => obj, 
+    // Is this safe?
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    [...Object.keys(obj), ...Object.values(obj)]);
+}
+/**
+ * This component renders nothing by itself, but it fills the placeholder in the
+ * generic secondary menu layout. This reduces coupling between the main layout
+ * and the specific page.
+ *
+ * This kind of feature is often called portal/teleport/gateway/outlet...
+ * Various unmaintained React libs exist. Most up-to-date one:
+ * https://github.com/gregberge/react-teleporter
+ * Not sure any of those is safe regarding concurrent mode.
+ */
+export function NavbarSecondaryMenuFiller({ component, props, }) {
+    const [, setState] = useNavbarSecondaryMenuContext();
+    // To avoid useless context re-renders, props are memoized shallowly
+    const memoizedProps = useShallowMemoizedObject(props);
+    useEffect(() => {
+        // @ts-expect-error: context is not 100% type-safe but it's ok
+        setState((s) => ({ ...s, content: { component, props: memoizedProps } }));
+    }, [setState, component, memoizedProps]);
+    useEffect(() => () => setState((s) => ({ ...s, component: null, props: null })), [setState]);
+    return null;
+}
+function renderElement(state) {
+    if (state.content?.component) {
+        const Comp = state.content.component;
+        return React.createElement(Comp, { ...state.content.props });
+    }
+    return undefined;
+}
+/** Wires the logic for rendering the mobile navbar secondary menu. */
+export function useNavbarSecondaryMenu() {
+    const [state, setState] = useNavbarSecondaryMenuContext();
+    const hide = useCallback(() => setState((s) => ({ ...s, shown: false })), [setState]);
+    return useMemo(() => ({ shown: state.shown, hide, content: renderElement(state) }), [hide, state]);
+}
+//# sourceMappingURL=navbarSecondaryMenu.js.map

package/lib/contexts/navbarSecondaryMenu.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"navbarSecondaryMenu.js","sourceRoot":"","sources":["../../src/contexts/navbarSecondaryMenu.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,EACZ,QAAQ,EACR,UAAU,EACV,SAAS,EACT,OAAO,EACP,WAAW,GAGZ,MAAM,OAAO,CAAC;AACf,OAAO,EAAC,iBAAiB,EAAE,WAAW,EAAC,MAAM,qBAAqB,CAAC;AACnE,OAAO,EAAC,sBAAsB,EAAC,MAAM,uBAAuB,CAAC;AAc7D,MAAM,YAAY,GAAU;IAC1B,KAAK,EAAE,KAAK;IACZ,OAAO,EAAE,EAAC,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAC;CACxC,CAAC;AAOF,MAAM,OAAO,GAAG,KAAK,CAAC,aAAa,CAAsB,IAAI,CAAC,CAAC;AAE/D,SAAS,eAAe;IACtB,MAAM,aAAa,GAAG,sBAAsB,EAAE,CAAC;IAE/C,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,CAAQ,YAAY,CAAC,CAAC;IAExD,MAAM,QAAQ,GAAG,CAAC,KAAc,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAC,GAAG,CAAC,EAAE,KAAK,EAAC,CAAC,CAAC,CAAC;IAEtE,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,EAAE,SAAS,KAAK,IAAI,CAAC;IACrD,MAAM,kBAAkB,GAAG,WAAW,CAAC,KAAK,CAAC,OAAO,EAAE,SAAS,KAAK,IAAI,CAAC,CAAC;IAE1E,yEAAyE;IACzE,mCAAmC;IACnC,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,sBAAsB,GAAG,UAAU,IAAI,CAAC,kBAAkB,CAAC;QACjE,IAAI,sBAAsB,EAAE;YAC1B,QAAQ,CAAC,IAAI,CAAC,CAAC;SAChB;IACH,CAAC,EAAE,CAAC,UAAU,EAAE,kBAAkB,CAAC,CAAC,CAAC;IAErC,yEAAyE;IACzE,4CAA4C;IAC5C,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,CAAC,UAAU,EAAE;YACf,QAAQ,CAAC,KAAK,CAAC,CAAC;YAChB,OAAO;SACR;QACD,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE;YACxB,QAAQ,CAAC,IAAI,CAAC,CAAC;SAChB;IACH,CAAC,EAAE,CAAC,aAAa,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC;IAEtC,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;AAC3B,CAAC;AAED,MAAM,UAAU,2BAA2B,CAAC,EAC1C,QAAQ,GAGT;IACC,MAAM,KAAK,GAAG,eAAe,EAAE,CAAC;IAChC,OAAO,oBAAC,OAAO,CAAC,QAAQ,IAAC,KAAK,EAAE,KAAK,IAAG,QAAQ,CAAoB,CAAC;AACvE,CAAC;AAED,SAAS,6BAA6B;IACpC,MAAM,KAAK,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IAClC,IAAI,KAAK,KAAK,IAAI,EAAE;QAClB,MAAM,IAAI,iBAAiB,CAAC,6BAA6B,CAAC,CAAC;KAC5D;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,wBAAwB,CAAI,GAAM;IACzC,OAAO,OAAO,CACZ,GAAG,EAAE,CAAC,GAAG;IACT,gBAAgB;IAChB,uDAAuD;IACvD,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAC7C,CAAC;AACJ,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,yBAAyB,CAAmB,EAC1D,SAAS,EACT,KAAK,GAIN;IACC,MAAM,CAAC,EAAE,QAAQ,CAAC,GAAG,6BAA6B,EAAE,CAAC;IAErD,oEAAoE;IACpE,MAAM,aAAa,GAAG,wBAAwB,CAAC,KAAK,CAAC,CAAC;IAEtD,SAAS,CAAC,GAAG,EAAE;QACb,8DAA8D;QAC9D,QAAQ,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAC,GAAG,CAAC,EAAE,OAAO,EAAE,EAAC,SAAS,EAAE,KAAK,EAAE,aAAa,EAAC,EAAC,CAAC,CAAC,CAAC;IACxE,CAAC,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC,CAAC;IAEzC,SAAS,CACP,GAAG,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAC,GAAG,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAC,CAAC,CAAC,EACnE,CAAC,QAAQ,CAAC,CACX,CAAC;IAEF,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,aAAa,CAAC,KAAY;IACjC,IAAI,KAAK,CAAC,OAAO,EAAE,SAAS,EAAE;QAC5B,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC;QACrC,OAAO,oBAAC,IAAI,OAAK,KAAK,CAAC,OAAO,CAAC,KAAK,GAAI,CAAC;KAC1C;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,sEAAsE;AACtE,MAAM,UAAU,sBAAsB;IAWpC,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,6BAA6B,EAAE,CAAC;IAE1D,MAAM,IAAI,GAAG,WAAW,CACtB,GAAG,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAC,GAAG,CAAC,EAAE,KAAK,EAAE,KAAK,EAAC,CAAC,CAAC,EAC7C,CAAC,QAAQ,CAAC,CACX,CAAC;IAEF,OAAO,OAAO,CACZ,GAAG,EAAE,CAAC,CAAC,EAAC,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,aAAa,CAAC,KAAK,CAAC,EAAC,CAAC,EACjE,CAAC,IAAI,EAAE,KAAK,CAAC,CACd,CAAC;AACJ,CAAC"}

package/lib/{utils/tabGroupChoiceUtils.d.ts → contexts/tabGroupChoice.d.ts}

@@ -5,15 +5,17 @@
  * LICENSE file in the root directory of this source tree.
  */
 import { type ReactNode } from 'react';
-declare type TabGroupChoiceContextValue = {
+declare type ContextValue = {
+    /** A map from `groupId` to the `value` of the saved choice. */
     readonly tabGroupChoices: {
         readonly [groupId: string]: string;
     };
+    /** Set the new choice value of a group. */
     readonly setTabGroupChoices: (groupId: string, newChoice: string) => void;
 };
 export declare function TabGroupChoiceProvider({ children, }: {
     children: ReactNode;
 }): JSX.Element;
-export declare function useTabGroupChoice(): TabGroupChoiceContextValue;
+export declare function useTabGroupChoice(): ContextValue;
 export {};
-//# sourceMappingURL=tabGroupChoiceUtils.d.ts.map
+//# sourceMappingURL=tabGroupChoice.d.ts.map

package/lib/contexts/tabGroupChoice.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tabGroupChoice.d.ts","sourceRoot":"","sources":["../../src/contexts/tabGroupChoice.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAc,EAMZ,KAAK,SAAS,EACf,MAAM,OAAO,CAAC;AAMf,aAAK,YAAY,GAAG;IAClB,+DAA+D;IAC/D,QAAQ,CAAC,eAAe,EAAE;QAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAAA;KAAC,CAAC;IAC/D,2CAA2C;IAC3C,QAAQ,CAAC,kBAAkB,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,KAAK,IAAI,CAAC;CAC3E,CAAC;AAyCF,wBAAgB,sBAAsB,CAAC,EACrC,QAAQ,GACT,EAAE;IACD,QAAQ,EAAE,SAAS,CAAC;CACrB,GAAG,GAAG,CAAC,OAAO,CAGd;AAED,wBAAgB,iBAAiB,IAAI,YAAY,CAMhD"}

package/lib/{utils/tabGroupChoiceUtils.js → contexts/tabGroupChoice.js}

@@ -4,12 +4,12 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import React, { useState, useCallback, useEffect, createContext, useMemo, useContext, } from 'react';
-import { createStorageSlot, listStorageKeys } from './storageUtils';
-import { ReactContextError } from './reactUtils';
+import React, { useState, useCallback, useEffect, useMemo, useContext, } from 'react';
+import { createStorageSlot, listStorageKeys } from '../utils/storageUtils';
+import { ReactContextError } from '../utils/reactUtils';
 const TAB_CHOICE_PREFIX = 'docusaurus.tab.';
-const TabGroupChoiceContext = createContext(undefined);
-function useTabGroupChoiceContextValue() {
+const Context = React.createContext(undefined);
+function useContextValue() {
     const [tabGroupChoices, setChoices] = useState({});
     const setChoiceSyncWithLocalStorage = useCallback((groupId, newChoice) => {
         createStorageSlot(`${TAB_CHOICE_PREFIX}${groupId}`).set(newChoice);
@@ -29,27 +29,21 @@ function useTabGroupChoiceContextValue() {
             console.error(err);
         }
     }, []);
-    return {
-        tabGroupChoices,
-        setTabGroupChoices: (groupId, newChoice) => {
-            setChoices((oldChoices) => ({ ...oldChoices, [groupId]: newChoice }));
-            setChoiceSyncWithLocalStorage(groupId, newChoice);
-        },
-    };
+    const setTabGroupChoices = useCallback((groupId, newChoice) => {
+        setChoices((oldChoices) => ({ ...oldChoices, [groupId]: newChoice }));
+        setChoiceSyncWithLocalStorage(groupId, newChoice);
+    }, [setChoiceSyncWithLocalStorage]);
+    return useMemo(() => ({ tabGroupChoices, setTabGroupChoices }), [tabGroupChoices, setTabGroupChoices]);
 }
 export function TabGroupChoiceProvider({ children, }) {
-    const { tabGroupChoices, setTabGroupChoices } = useTabGroupChoiceContextValue();
-    const contextValue = useMemo(() => ({
-        tabGroupChoices,
-        setTabGroupChoices,
-    }), [tabGroupChoices, setTabGroupChoices]);
-    return (React.createElement(TabGroupChoiceContext.Provider, { value: contextValue }, children));
+    const value = useContextValue();
+    return React.createElement(Context.Provider, { value: value }, children);
 }
 export function useTabGroupChoice() {
-    const context = useContext(TabGroupChoiceContext);
+    const context = useContext(Context);
     if (context == null) {
         throw new ReactContextError('TabGroupChoiceProvider');
     }
     return context;
 }
-//# sourceMappingURL=tabGroupChoiceUtils.js.map
+//# sourceMappingURL=tabGroupChoice.js.map

package/lib/contexts/tabGroupChoice.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tabGroupChoice.js","sourceRoot":"","sources":["../../src/contexts/tabGroupChoice.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,EACZ,QAAQ,EACR,WAAW,EACX,SAAS,EACT,OAAO,EACP,UAAU,GAEX,MAAM,OAAO,CAAC;AACf,OAAO,EAAC,iBAAiB,EAAE,eAAe,EAAC,MAAM,uBAAuB,CAAC;AACzE,OAAO,EAAC,iBAAiB,EAAC,MAAM,qBAAqB,CAAC;AAEtD,MAAM,iBAAiB,GAAG,iBAAiB,CAAC;AAS5C,MAAM,OAAO,GAAG,KAAK,CAAC,aAAa,CAA2B,SAAS,CAAC,CAAC;AAEzE,SAAS,eAAe;IACtB,MAAM,CAAC,eAAe,EAAE,UAAU,CAAC,GAAG,QAAQ,CAE3C,EAAE,CAAC,CAAC;IACP,MAAM,6BAA6B,GAAG,WAAW,CAAC,CAAC,OAAO,EAAE,SAAS,EAAE,EAAE;QACvE,iBAAiB,CAAC,GAAG,iBAAiB,GAAG,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACrE,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,SAAS,CAAC,GAAG,EAAE;QACb,IAAI;YACF,MAAM,mBAAmB,GAAgC,EAAE,CAAC;YAC5D,eAAe,EAAE,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;gBACvC,IAAI,UAAU,CAAC,UAAU,CAAC,iBAAiB,CAAC,EAAE;oBAC5C,MAAM,OAAO,GAAG,UAAU,CAAC,SAAS,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;oBAC/D,mBAAmB,CAAC,OAAO,CAAC,GAAG,iBAAiB,CAAC,UAAU,CAAC,CAAC,GAAG,EAAG,CAAC;iBACrE;YACH,CAAC,CAAC,CAAC;YACH,UAAU,CAAC,mBAAmB,CAAC,CAAC;SACjC;QAAC,OAAO,GAAG,EAAE;YACZ,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;SACpB;IACH,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,MAAM,kBAAkB,GAAG,WAAW,CACpC,CAAC,OAAe,EAAE,SAAiB,EAAE,EAAE;QACrC,UAAU,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,EAAC,GAAG,UAAU,EAAE,CAAC,OAAO,CAAC,EAAE,SAAS,EAAC,CAAC,CAAC,CAAC;QACpE,6BAA6B,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IACpD,CAAC,EACD,CAAC,6BAA6B,CAAC,CAChC,CAAC;IAEF,OAAO,OAAO,CACZ,GAAG,EAAE,CAAC,CAAC,EAAC,eAAe,EAAE,kBAAkB,EAAC,CAAC,EAC7C,CAAC,eAAe,EAAE,kBAAkB,CAAC,CACtC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,EACrC,QAAQ,GAGT;IACC,MAAM,KAAK,GAAG,eAAe,EAAE,CAAC;IAChC,OAAO,oBAAC,OAAO,CAAC,QAAQ,IAAC,KAAK,EAAE,KAAK,IAAG,QAAQ,CAAoB,CAAC;AACvE,CAAC;AAED,MAAM,UAAU,iBAAiB;IAC/B,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IACpC,IAAI,OAAO,IAAI,IAAI,EAAE;QACnB,MAAM,IAAI,iBAAiB,CAAC,wBAAwB,CAAC,CAAC;KACvD;IACD,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/lib/hooks/useHideableNavbar.d.ts

@@ -4,10 +4,14 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-declare type UseHideableNavbarReturns = {
+/**
+ * Wires the imperative logic of a hideable navbar.
+ * @param hideOnScroll If `false`, this hook is basically a no-op.
+ */
+export declare function useHideableNavbar(hideOnScroll: boolean): {
+    /** A ref to the navbar component. Plug this into the actual element. */
     readonly navbarRef: (node: HTMLElement | null) => void;
+    /** If `false`, the navbar component should not be rendered. */
     readonly isNavbarVisible: boolean;
 };
-export default function useHideableNavbar(hideOnScroll: boolean): UseHideableNavbarReturns;
-export {};
 //# sourceMappingURL=useHideableNavbar.d.ts.map

package/lib/hooks/useHideableNavbar.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useHideableNavbar.d.ts","sourceRoot":"","sources":["../../src/hooks/useHideableNavbar.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAMH,aAAK,wBAAwB,GAAG;IAC9B,QAAQ,CAAC,SAAS,EAAE,CAAC,IAAI,EAAE,WAAW,GAAG,IAAI,KAAK,IAAI,CAAC;IACvD,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAC;CACnC,CAAC;AAEF,MAAM,CAAC,OAAO,UAAU,iBAAiB,CACvC,YAAY,EAAE,OAAO,GACpB,wBAAwB,CA0D1B"}
+{"version":3,"file":"useHideableNavbar.d.ts","sourceRoot":"","sources":["../../src/hooks/useHideableNavbar.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAMH;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,YAAY,EAAE,OAAO,GAAG;IACxD,wEAAwE;IACxE,QAAQ,CAAC,SAAS,EAAE,CAAC,IAAI,EAAE,WAAW,GAAG,IAAI,KAAK,IAAI,CAAC;IACvD,+DAA+D;IAC/D,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAC;CACnC,CAwDA"}

package/lib/hooks/useHideableNavbar.js

@@ -7,7 +7,11 @@
 import { useState, useCallback, useRef } from 'react';
 import { useLocationChange } from '../utils/useLocationChange';
 import { useScrollPosition } from '../utils/scrollUtils';
-export default function useHideableNavbar(hideOnScroll) {
+/**
+ * Wires the imperative logic of a hideable navbar.
+ * @param hideOnScroll If `false`, this hook is basically a no-op.
+ */
+export function useHideableNavbar(hideOnScroll) {
     const [isNavbarVisible, setIsNavbarVisible] = useState(hideOnScroll);
     const isFocusedAnchor = useRef(false);
     const navbarHeight = useRef(0);
@@ -21,7 +25,8 @@ export default function useHideableNavbar(hideOnScroll) {
             return;
         }
         const scrollTop = currentPosition.scrollY;
-        // It needed for mostly to handle rubber band scrolling
+        // Needed mostly for handling rubber band scrolling.
+        // See https://github.com/facebook/docusaurus/pull/5721
         if (scrollTop < navbarHeight.current) {
             setIsNavbarVisible(true);
             return;
@@ -51,9 +56,6 @@ export default function useHideableNavbar(hideOnScroll) {
         }
         setIsNavbarVisible(true);
     });
-    return {
-        navbarRef,
-        isNavbarVisible,
-    };
+    return { navbarRef, isNavbarVisible };
 }
 //# sourceMappingURL=useHideableNavbar.js.map