@docusaurus/theme-common 2.0.0-beta.1ec2c95e3 → 2.0.0-beta.21

package/lib/contexts/colorMode.js

@@ -0,0 +1,132 @@
+/**
+ * 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, useCallback, useEffect, useContext, useMemo, useRef, } from 'react';
+import ExecutionEnvironment from '@docusaurus/ExecutionEnvironment';
+import { ReactContextError } from '../utils/reactUtils';
+import { createStorageSlot } from '../utils/storageUtils';
+import { useThemeConfig } from '../utils/useThemeConfig';
+const Context = React.createContext(undefined);
+const ColorModeStorageKey = 'theme';
+const ColorModeStorage = createStorageSlot(ColorModeStorageKey);
+const ColorModes = {
+    light: 'light',
+    dark: 'dark',
+};
+// Ensure to always return a valid colorMode even if input is invalid
+const coerceToColorMode = (colorMode) => colorMode === ColorModes.dark ? ColorModes.dark : ColorModes.light;
+const getInitialColorMode = (defaultMode) => ExecutionEnvironment.canUseDOM
+    ? coerceToColorMode(document.documentElement.getAttribute('data-theme'))
+    : coerceToColorMode(defaultMode);
+const storeColorMode = (newColorMode) => {
+    ColorModeStorage.set(coerceToColorMode(newColorMode));
+};
+function useContextValue() {
+    const { colorMode: { defaultMode, disableSwitch, respectPrefersColorScheme }, } = useThemeConfig();
+    const [colorMode, setColorModeState] = useState(getInitialColorMode(defaultMode));
+    useEffect(() => {
+        // A site is deployed without disableSwitch
+        // => User visits the site and has a persisted value
+        // => Site later enabled disableSwitch
+        // => Clear the previously stored value to apply the site's setting
+        if (disableSwitch) {
+            ColorModeStorage.del();
+        }
+    }, [disableSwitch]);
+    const setColorMode = useCallback((newColorMode, options = {}) => {
+        const { persist = true } = options;
+        if (newColorMode) {
+            setColorModeState(newColorMode);
+            if (persist) {
+                storeColorMode(newColorMode);
+            }
+        }
+        else {
+            if (respectPrefersColorScheme) {
+                setColorModeState(window.matchMedia('(prefers-color-scheme: dark)').matches
+                    ? ColorModes.dark
+                    : ColorModes.light);
+            }
+            else {
+                setColorModeState(defaultMode);
+            }
+            ColorModeStorage.del();
+        }
+    }, [respectPrefersColorScheme, defaultMode]);
+    useEffect(() => {
+        document.documentElement.setAttribute('data-theme', coerceToColorMode(colorMode));
+    }, [colorMode]);
+    useEffect(() => {
+        if (disableSwitch) {
+            return undefined;
+        }
+        const onChange = (e) => {
+            if (e.key !== ColorModeStorageKey) {
+                return;
+            }
+            const storedColorMode = ColorModeStorage.get();
+            if (storedColorMode !== null) {
+                setColorMode(coerceToColorMode(storedColorMode));
+            }
+        };
+        window.addEventListener('storage', onChange);
+        return () => window.removeEventListener('storage', onChange);
+    }, [disableSwitch, setColorMode]);
+    // PCS is coerced to light mode when printing, which causes the color mode to
+    // be reset to dark when exiting print mode, disregarding user settings. When
+    // the listener fires only because of a print/screen switch, we don't change
+    // color mode. See https://github.com/facebook/docusaurus/pull/6490
+    const previousMediaIsPrint = useRef(false);
+    useEffect(() => {
+        if (disableSwitch && !respectPrefersColorScheme) {
+            return undefined;
+        }
+        const mql = window.matchMedia('(prefers-color-scheme: dark)');
+        const onChange = () => {
+            if (window.matchMedia('print').matches || previousMediaIsPrint.current) {
+                previousMediaIsPrint.current = window.matchMedia('print').matches;
+                return;
+            }
+            setColorMode(null);
+        };
+        mql.addListener(onChange);
+        return () => mql.removeListener(onChange);
+    }, [setColorMode, disableSwitch, respectPrefersColorScheme]);
+    return useMemo(() => ({
+        colorMode,
+        setColorMode,
+        get isDarkTheme() {
+            if (process.env.NODE_ENV === 'development') {
+                console.error('`useColorMode().isDarkTheme` is deprecated. Please use `useColorMode().colorMode === "dark"` instead.');
+            }
+            return colorMode === ColorModes.dark;
+        },
+        setLightTheme() {
+            if (process.env.NODE_ENV === 'development') {
+                console.error('`useColorMode().setLightTheme` is deprecated. Please use `useColorMode().setColorMode("light")` instead.');
+            }
+            setColorMode(ColorModes.light);
+        },
+        setDarkTheme() {
+            if (process.env.NODE_ENV === 'development') {
+                console.error('`useColorMode().setDarkTheme` is deprecated. Please use `useColorMode().setColorMode("dark")` instead.');
+            }
+            setColorMode(ColorModes.dark);
+        },
+    }), [colorMode, setColorMode]);
+}
+export function ColorModeProvider({ children, }) {
+    const value = useContextValue();
+    return <Context.Provider value={value}>{children}</Context.Provider>;
+}
+export function useColorMode() {
+    const context = useContext(Context);
+    if (context == null) {
+        throw new ReactContextError('ColorModeProvider', 'Please see https://docusaurus.io/docs/api/themes/configuration#use-color-mode.');
+    }
+    return context;
+}
+//# sourceMappingURL=colorMode.js.map

package/lib/contexts/colorMode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"colorMode.js","sourceRoot":"","sources":["../../src/contexts/colorMode.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,EACZ,QAAQ,EACR,WAAW,EACX,SAAS,EACT,UAAU,EACV,OAAO,EACP,MAAM,GAEP,MAAM,OAAO,CAAC;AACf,OAAO,oBAAoB,MAAM,kCAAkC,CAAC;AACpE,OAAO,EAAC,iBAAiB,EAAC,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAC,iBAAiB,EAAC,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAC,cAAc,EAAC,MAAM,yBAAyB,CAAC;AAcvD,MAAM,OAAO,GAAG,KAAK,CAAC,aAAa,CAA2B,SAAS,CAAC,CAAC;AAEzE,MAAM,mBAAmB,GAAG,OAAO,CAAC;AACpC,MAAM,gBAAgB,GAAG,iBAAiB,CAAC,mBAAmB,CAAC,CAAC;AAEhE,MAAM,UAAU,GAAG;IACjB,KAAK,EAAE,OAAO;IACd,IAAI,EAAE,MAAM;CACJ,CAAC;AAIX,qEAAqE;AACrE,MAAM,iBAAiB,GAAG,CAAC,SAAyB,EAAa,EAAE,CACjE,SAAS,KAAK,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC;AAErE,MAAM,mBAAmB,GAAG,CAAC,WAAkC,EAAa,EAAE,CAC5E,oBAAoB,CAAC,SAAS;IAC5B,CAAC,CAAC,iBAAiB,CAAC,QAAQ,CAAC,eAAe,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;IACxE,CAAC,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;AAErC,MAAM,cAAc,GAAG,CAAC,YAAuB,EAAE,EAAE;IACjD,gBAAgB,CAAC,GAAG,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC,CAAC;AACxD,CAAC,CAAC;AAEF,SAAS,eAAe;IACtB,MAAM,EACJ,SAAS,EAAE,EAAC,WAAW,EAAE,aAAa,EAAE,yBAAyB,EAAC,GACnE,GAAG,cAAc,EAAE,CAAC;IACrB,MAAM,CAAC,SAAS,EAAE,iBAAiB,CAAC,GAAG,QAAQ,CAC7C,mBAAmB,CAAC,WAAW,CAAC,CACjC,CAAC;IAEF,SAAS,CAAC,GAAG,EAAE;QACb,2CAA2C;QAC3C,oDAAoD;QACpD,sCAAsC;QACtC,mEAAmE;QACnE,IAAI,aAAa,EAAE;YACjB,gBAAgB,CAAC,GAAG,EAAE,CAAC;SACxB;IACH,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC;IAEpB,MAAM,YAAY,GAAG,WAAW,CAC9B,CAAC,YAA8B,EAAE,UAA+B,EAAE,EAAE,EAAE;QACpE,MAAM,EAAC,OAAO,GAAG,IAAI,EAAC,GAAG,OAAO,CAAC;QACjC,IAAI,YAAY,EAAE;YAChB,iBAAiB,CAAC,YAAY,CAAC,CAAC;YAChC,IAAI,OAAO,EAAE;gBACX,cAAc,CAAC,YAAY,CAAC,CAAC;aAC9B;SACF;aAAM;YACL,IAAI,yBAAyB,EAAE;gBAC7B,iBAAiB,CACf,MAAM,CAAC,UAAU,CAAC,8BAA8B,CAAC,CAAC,OAAO;oBACvD,CAAC,CAAC,UAAU,CAAC,IAAI;oBACjB,CAAC,CAAC,UAAU,CAAC,KAAK,CACrB,CAAC;aACH;iBAAM;gBACL,iBAAiB,CAAC,WAAW,CAAC,CAAC;aAChC;YACD,gBAAgB,CAAC,GAAG,EAAE,CAAC;SACxB;IACH,CAAC,EACD,CAAC,yBAAyB,EAAE,WAAW,CAAC,CACzC,CAAC;IAEF,SAAS,CAAC,GAAG,EAAE;QACb,QAAQ,CAAC,eAAe,CAAC,YAAY,CACnC,YAAY,EACZ,iBAAiB,CAAC,SAAS,CAAC,CAC7B,CAAC;IACJ,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhB,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,aAAa,EAAE;YACjB,OAAO,SAAS,CAAC;SAClB;QACD,MAAM,QAAQ,GAAG,CAAC,CAAe,EAAE,EAAE;YACnC,IAAI,CAAC,CAAC,GAAG,KAAK,mBAAmB,EAAE;gBACjC,OAAO;aACR;YACD,MAAM,eAAe,GAAG,gBAAgB,CAAC,GAAG,EAAE,CAAC;YAC/C,IAAI,eAAe,KAAK,IAAI,EAAE;gBAC5B,YAAY,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC,CAAC;aAClD;QACH,CAAC,CAAC;QACF,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAC7C,OAAO,GAAG,EAAE,CAAC,MAAM,CAAC,mBAAmB,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAC/D,CAAC,EAAE,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC,CAAC;IAElC,6EAA6E;IAC7E,6EAA6E;IAC7E,4EAA4E;IAC5E,mEAAmE;IACnE,MAAM,oBAAoB,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IAE3C,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,aAAa,IAAI,CAAC,yBAAyB,EAAE;YAC/C,OAAO,SAAS,CAAC;SAClB;QACD,MAAM,GAAG,GAAG,MAAM,CAAC,UAAU,CAAC,8BAA8B,CAAC,CAAC;QAC9D,MAAM,QAAQ,GAAG,GAAG,EAAE;YACpB,IAAI,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,OAAO,IAAI,oBAAoB,CAAC,OAAO,EAAE;gBACtE,oBAAoB,CAAC,OAAO,GAAG,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC;gBAClE,OAAO;aACR;YACD,YAAY,CAAC,IAAI,CAAC,CAAC;QACrB,CAAC,CAAC;QACF,GAAG,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAC1B,OAAO,GAAG,EAAE,CAAC,GAAG,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IAC5C,CAAC,EAAE,CAAC,YAAY,EAAE,aAAa,EAAE,yBAAyB,CAAC,CAAC,CAAC;IAE7D,OAAO,OAAO,CACZ,GAAG,EAAE,CAAC,CAAC;QACL,SAAS;QACT,YAAY;QACZ,IAAI,WAAW;YACb,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,aAAa,EAAE;gBAC1C,OAAO,CAAC,KAAK,CACX,uGAAuG,CACxG,CAAC;aACH;YACD,OAAO,SAAS,KAAK,UAAU,CAAC,IAAI,CAAC;QACvC,CAAC;QACD,aAAa;YACX,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,aAAa,EAAE;gBAC1C,OAAO,CAAC,KAAK,CACX,0GAA0G,CAC3G,CAAC;aACH;YACD,YAAY,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QACjC,CAAC;QACD,YAAY;YACV,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,aAAa,EAAE;gBAC1C,OAAO,CAAC,KAAK,CACX,wGAAwG,CACzG,CAAC;aACH;YACD,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC;KACF,CAAC,EACF,CAAC,SAAS,EAAE,YAAY,CAAC,CAC1B,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,EAChC,QAAQ,GAGT;IACC,MAAM,KAAK,GAAG,eAAe,EAAE,CAAC;IAChC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;AACvE,CAAC;AAED,MAAM,UAAU,YAAY;IAC1B,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IACpC,IAAI,OAAO,IAAI,IAAI,EAAE;QACnB,MAAM,IAAI,iBAAiB,CACzB,mBAAmB,EACnB,gFAAgF,CACjF,CAAC;KACH;IACD,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/lib/contexts/docSidebarItemsExpandedState.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 = {
+    /**
+     * The item that the user last opened, `null` when there's none open. On
+     * initial render, it will always be `null`, which doesn't necessarily mean
+     * there's no category open (can have 0, 1, or many being initially open).
+     */
+    expandedItem: number | null;
+    /**
+     * Set the currently expanded item, when the user opens one. Set the value to
+     * `null` when the user closes an open category.
+     */
+    setExpandedItem: (a: number | null) => void;
+};
+/**
+ * Should be used to wrap one sidebar category level. This provider syncs the
+ * expanded states of all sibling categories, and categories can choose to
+ * collapse itself if another one is expanded.
+ */
+export declare function DocSidebarItemsExpandedStateProvider({ children, }: {
+    children: ReactNode;
+}): JSX.Element;
+export declare function useDocSidebarItemsExpandedState(): ContextValue;
+export {};
+//# sourceMappingURL=docSidebarItemsExpandedState.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"docSidebarItemsExpandedState.d.ts","sourceRoot":"","sources":["../../src/contexts/docSidebarItemsExpandedState.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAc,EAAC,KAAK,SAAS,EAAgC,MAAM,OAAO,CAAC;AAG3E,aAAK,YAAY,GAAG;IAClB;;;;OAIG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B;;;OAGG;IACH,eAAe,EAAE,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI,KAAK,IAAI,CAAC;CAC7C,CAAC;AAOF;;;;GAIG;AACH,wBAAgB,oCAAoC,CAAC,EACnD,QAAQ,GACT,EAAE;IACD,QAAQ,EAAE,SAAS,CAAC;CACrB,GAAG,GAAG,CAAC,OAAO,CAQd;AAED,wBAAgB,+BAA+B,IAAI,YAAY,CAM9D"}

package/lib/contexts/docSidebarItemsExpandedState.js

@@ -0,0 +1,28 @@
+/**
+ * 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, { useMemo, useState, useContext } from 'react';
+import { ReactContextError } from '../utils/reactUtils';
+const EmptyContext = Symbol('EmptyContext');
+const Context = React.createContext(EmptyContext);
+/**
+ * Should be used to wrap one sidebar category level. This provider syncs the
+ * expanded states of all sibling categories, and categories can choose to
+ * collapse itself if another one is expanded.
+ */
+export function DocSidebarItemsExpandedStateProvider({ children, }) {
+    const [expandedItem, setExpandedItem] = useState(null);
+    const contextValue = useMemo(() => ({ expandedItem, setExpandedItem }), [expandedItem]);
+    return <Context.Provider value={contextValue}>{children}</Context.Provider>;
+}
+export function useDocSidebarItemsExpandedState() {
+    const value = useContext(Context);
+    if (value === EmptyContext) {
+        throw new ReactContextError('DocSidebarItemsExpandedStateProvider');
+    }
+    return value;
+}
+//# sourceMappingURL=docSidebarItemsExpandedState.js.map

package/lib/contexts/docSidebarItemsExpandedState.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"docSidebarItemsExpandedState.js","sourceRoot":"","sources":["../../src/contexts/docSidebarItemsExpandedState.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,EAAiB,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAC,MAAM,OAAO,CAAC;AAC3E,OAAO,EAAC,iBAAiB,EAAC,MAAM,qBAAqB,CAAC;AAgBtD,MAAM,YAAY,GAAkB,MAAM,CAAC,cAAc,CAAC,CAAC;AAC3D,MAAM,OAAO,GAAG,KAAK,CAAC,aAAa,CACjC,YAAY,CACb,CAAC;AAEF;;;;GAIG;AACH,MAAM,UAAU,oCAAoC,CAAC,EACnD,QAAQ,GAGT;IACC,MAAM,CAAC,YAAY,EAAE,eAAe,CAAC,GAAG,QAAQ,CAAgB,IAAI,CAAC,CAAC;IACtE,MAAM,YAAY,GAAG,OAAO,CAC1B,GAAG,EAAE,CAAC,CAAC,EAAC,YAAY,EAAE,eAAe,EAAC,CAAC,EACvC,CAAC,YAAY,CAAC,CACf,CAAC;IAEF,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;AAC9E,CAAC;AAED,MAAM,UAAU,+BAA+B;IAC7C,MAAM,KAAK,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IAClC,IAAI,KAAK,KAAK,YAAY,EAAE;QAC1B,MAAM,IAAI,iBAAiB,CAAC,sCAAsC,CAAC,CAAC;KACrE;IACD,OAAO,KAAK,CAAC;AACf,CAAC"}

package/lib/contexts/docsPreferredVersion.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.
+ */
+/// <reference types="react" />
+/// <reference types="@docusaurus/plugin-content-docs" />
+import { type GlobalVersion } from '@docusaurus/plugin-content-docs/client';
+/**
+ * This is a maybe-layer. If the docs plugin is not enabled, this provider is a
+ * simple pass-through.
+ */
+export declare function DocsPreferredVersionContextProvider({ children, }: {
+    children: JSX.Element;
+}): JSX.Element;
+/**
+ * Returns a read-write interface to a plugin's preferred version. The
+ * "preferred version" is defined as the last version that the user visited.
+ * For example, if a user is using v3, even when v4 is later published, the user
+ * would still be browsing v3 docs when she opens the website next time. Note,
+ * the `preferredVersion` attribute will always be `null` before mount.
+ */
+export declare function useDocsPreferredVersion(pluginId?: string | undefined): {
+    preferredVersion: GlobalVersion | null;
+    savePreferredVersionName: (versionName: string) => void;
+};
+export declare function useDocsPreferredVersionByPluginId(): {
+    [pluginId: string]: GlobalVersion | null;
+};
+//# sourceMappingURL=docsPreferredVersion.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"docsPreferredVersion.d.ts","sourceRoot":"","sources":["../../src/contexts/docsPreferredVersion.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;;;AAUH,OAAO,EAIL,KAAK,aAAa,EACnB,MAAM,wCAAwC,CAAC;AAsJhD;;;GAGG;AACH,wBAAgB,mCAAmC,CAAC,EAClD,QAAQ,GACT,EAAE;IACD,QAAQ,EAAE,GAAG,CAAC,OAAO,CAAC;CACvB,GAAG,GAAG,CAAC,OAAO,CASd;AAUD;;;;;;GAMG;AACH,wBAAgB,uBAAuB,CACrC,QAAQ,GAAE,MAAM,GAAG,SAA6B,GAC/C;IACD,gBAAgB,EAAE,aAAa,GAAG,IAAI,CAAC;IACvC,wBAAwB,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK,IAAI,CAAC;CACzD,CAmBA;AAED,wBAAgB,iCAAiC,IAAI;IACnD,CAAC,QAAQ,EAAE,MAAM,GAAG,aAAa,GAAG,IAAI,CAAC;CAC1C,CAkBA"}

package/lib/contexts/docsPreferredVersion.js

@@ -0,0 +1,130 @@
+/**
+ * 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 { useAllDocsData, useDocsData, } from '@docusaurus/plugin-content-docs/client';
+import { DEFAULT_PLUGIN_ID } from '@docusaurus/constants';
+import { useThemeConfig, } from '../utils/useThemeConfig';
+import { isDocsPluginEnabled } from '../utils/docsUtils';
+import { ReactContextError } from '../utils/reactUtils';
+import { createStorageSlot } from '../utils/storageUtils';
+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 <Context.Provider value={value}>{children}</Context.Provider>;
+}
+/**
+ * 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 (<DocsPreferredVersionContextProviderUnsafe>
+        {children}
+      </DocsPreferredVersionContextProviderUnsafe>);
+    }
+    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. The
+ * "preferred version" is defined as the last version that the user visited.
+ * For example, if a user is using v3, even when v4 is later published, the user
+ * would still be browsing v3 docs when she opens the website next time. 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,EACd,WAAW,GAGZ,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAC,iBAAiB,EAAC,MAAM,uBAAuB,CAAC;AACxD,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,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,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;AACvE,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,mCAAmC,CAAC,EAClD,QAAQ,GAGT;IACC,IAAI,mBAAmB,EAAE;QACvB,OAAO,CACL,CAAC,yCAAyC,CACxC;QAAA,CAAC,QAAQ,CACX;MAAA,EAAE,yCAAyC,CAAC,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;;;;;;GAMG;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,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 ReactNode } from 'react';
+import type { PropSidebar } from '@docusaurus/plugin-content-docs';
+declare type ContextValue = {
+    name: string;
+    items: PropSidebar;
+};
+/**
+ * Provide the current sidebar to your children.
+ */
+export declare function DocsSidebarProvider({ children, name, items, }: {
+    children: ReactNode;
+    name: string | undefined;
+    items: PropSidebar | undefined;
+}): JSX.Element;
+/**
+ * Gets the sidebar that's currently displayed, or `null` if there isn't one
+ */
+export declare function useDocsSidebar(): ContextValue | null;
+export {};
+//# 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,EAAsB,KAAK,SAAS,EAAC,MAAM,OAAO,CAAC;AAEjE,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,iCAAiC,CAAC;AAMjE,aAAK,YAAY,GAAG;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,WAAW,CAAA;CAAC,CAAC;AAMvD;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,EAClC,QAAQ,EACR,IAAI,EACJ,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,SAAS,CAAC;IACpB,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,KAAK,EAAE,WAAW,GAAG,SAAS,CAAC;CAChC,GAAG,GAAG,CAAC,OAAO,CAMd;AAED;;GAEG;AACH,wBAAgB,cAAc,IAAI,YAAY,GAAG,IAAI,CAMpD"}

package/lib/contexts/docsSidebar.js

@@ -0,0 +1,30 @@
+/**
+ * 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, { useMemo, 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, name, items, }) {
+    const stableValue = useMemo(() => (name && items ? { name, items } : null), [name, items]);
+    return <Context.Provider value={stableValue}>{children}</Context.Provider>;
+}
+/**
+ * Gets the sidebar that's currently displayed, or `null` if there isn't one
+ */
+export function useDocsSidebar() {
+    const value = useContext(Context);
+    if (value === EmptyContext) {
+        throw new ReactContextError('DocsSidebarProvider');
+    }
+    return value;
+}
+//# 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,EAAC,OAAO,EAAE,UAAU,EAAiB,MAAM,OAAO,CAAC;AACjE,OAAO,EAAC,iBAAiB,EAAC,MAAM,qBAAqB,CAAC;AAGtD,+EAA+E;AAC/E,6FAA6F;AAC7F,MAAM,YAAY,GAAkB,MAAM,CAAC,cAAc,CAAC,CAAC;AAI3D,MAAM,OAAO,GAAG,KAAK,CAAC,aAAa,CACjC,YAAY,CACb,CAAC;AAEF;;GAEG;AACH,MAAM,UAAU,mBAAmB,CAAC,EAClC,QAAQ,EACR,IAAI,EACJ,KAAK,GAKN;IACC,MAAM,WAAW,GAAwB,OAAO,CAC9C,GAAG,EAAE,CAAC,CAAC,IAAI,IAAI,KAAK,CAAC,CAAC,CAAC,EAAC,IAAI,EAAE,KAAK,EAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAC5C,CAAC,IAAI,EAAE,KAAK,CAAC,CACd,CAAC;IACF,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;AAC7E,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,cAAc;IAC5B,MAAM,KAAK,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IAClC,IAAI,KAAK,KAAK,YAAY,EAAE;QAC1B,MAAM,IAAI,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;KACpD;IACD,OAAO,KAAK,CAAC;AACf,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;AAExD,OAAO,KAAK,EAAC,mBAAmB,EAAC,MAAM,iCAAiC,CAAC;AAIzE;;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 <Context.Provider value={version}>{children}</Context.Provider>;
+}
+/**
+ * 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;AACxD,OAAO,EAAC,iBAAiB,EAAC,MAAM,qBAAqB,CAAC;AAGtD,MAAM,OAAO,GAAG,KAAK,CAAC,aAAa,CAA6B,IAAI,CAAC,CAAC;AAEtE;;GAEG;AACH,MAAM,UAAU,mBAAmB,CAAC,EAClC,QAAQ,EACR,OAAO,GAIR;IACC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,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 { useNavbarSecondaryMenuContent } from './navbarSecondaryMenu/content';
+import { useWindowSize } from '../hooks/useWindowSize';
+import { useHistoryPopHandler } from '../utils/historyUtils';
+import { useThemeConfig } from '../utils/useThemeConfig';
+import { ReactContextError } from '../utils/reactUtils';
+const Context = React.createContext(undefined);
+function useIsNavbarMobileSidebarDisabled() {
+    const secondaryMenuContent = useNavbarSecondaryMenuContent();
+    const { items } = useThemeConfig().navbar;
+    return items.length === 0 && !secondaryMenuContent.component;
+}
+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);
+            // Prevent pop navigation; seems desirable enough
+            // See https://github.com/facebook/docusaurus/pull/5462#issuecomment-911699846
+            return false;
+        }
+        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 <Context.Provider value={value}>{children}</Context.Provider>;
+}
+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,6BAA6B,EAAC,MAAM,+BAA+B,CAAC;AAC5E,OAAO,EAAC,aAAa,EAAC,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAC,oBAAoB,EAAC,MAAM,uBAAuB,CAAC;AAC3D,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,oBAAoB,GAAG,6BAA6B,EAAE,CAAC;IAC7D,MAAM,EAAC,KAAK,EAAC,GAAG,cAAc,EAAE,CAAC,MAAM,CAAC;IACxC,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC;AAC/D,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,iDAAiD;YACjD,8EAA8E;YAC9E,OAAO,KAAK,CAAC;SACd;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,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,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/content.d.ts

@@ -0,0 +1,37 @@
+/**
+ * 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>;
+/** @internal */
+export declare type Content = {
+    component: NavbarSecondaryMenuComponent<object>;
+    props: object;
+} | {
+    component: null;
+    props: null;
+};
+/** @internal */
+export declare function NavbarSecondaryMenuContentProvider({ children, }: {
+    children: ReactNode;
+}): JSX.Element;
+/** @internal */
+export declare function useNavbarSecondaryMenuContent(): Content;
+/**
+ * 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;
+//# sourceMappingURL=content.d.ts.map