@docusaurus/theme-common 2.0.0-beta.2 → 2.0.0-beta.20

package/Details.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 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.
+ */
+
+// `Details` is a separate export entry because of side-effects messing with CSS
+// insertion order. See https://github.com/facebook/docusaurus/pull/7085.
+// However, because TS doesn't recognize `exports` (also a problem in
+// `content-docs`), we have to manually create a stub.
+
+// eslint-disable-next-line import/named
+export {Details, type DetailsProps} from './lib/components/Details';

package/lib/components/Collapsible/index.d.ts

@@ -0,0 +1,64 @@
+/**
+ * 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 Dispatch, type SetStateAction, type ReactNode } from 'react';
+/**
+ * This hook is a very thin wrapper around a `useState`.
+ */
+export declare function useCollapsible({ initialState, }: {
+    /** The initial state. Will be non-collapsed by default. */
+    initialState: boolean | (() => boolean);
+}): {
+    collapsed: boolean;
+    setCollapsed: Dispatch<SetStateAction<boolean>>;
+    toggleCollapsed: () => void;
+};
+declare type CollapsibleAnimationConfig = {
+    duration?: number;
+    easing?: string;
+};
+declare type CollapsibleElementType = React.ElementType<Pick<React.HTMLAttributes<unknown>, 'className' | 'onTransitionEnd' | 'style'>>;
+declare type CollapsibleBaseProps = {
+    /** The actual DOM element to be used in the markup. */
+    as?: CollapsibleElementType;
+    /** Initial collapsed state. */
+    collapsed: boolean;
+    children: ReactNode;
+    /** Configuration of animation, like `duration` and `easing` */
+    animation?: CollapsibleAnimationConfig;
+    /**
+     * A callback fired when the collapse transition animation ends. Receives
+     * the **new** collapsed state: e.g. when
+     * expanding, `collapsed` will be `false`. You can use this for some "cleanup"
+     * like applying new styles when the container is fully expanded.
+     */
+    onCollapseTransitionEnd?: (collapsed: boolean) => void;
+    /** Class name for the underlying DOM element. */
+    className?: string;
+    /**
+     * This is mostly useful for details/summary component where ssrStyle is not
+     * needed (as details are hidden natively) and can mess up with the browser's
+     * native behavior when JS fails to load or is disabled
+     */
+    disableSSRStyle?: boolean;
+};
+declare type CollapsibleProps = CollapsibleBaseProps & {
+    /**
+     * Delay rendering of the content till first expansion. Marked as required to
+     * force us to think if content should be server-rendered or not. This has
+     * perf impact since it reduces html file sizes, but could undermine SEO.
+     * @see https://github.com/facebook/docusaurus/issues/4753
+     */
+    lazy: boolean;
+};
+/**
+ * A headless component providing smooth and uniform collapsing behavior. The
+ * component will be invisible (zero height) when collapsed. Doesn't provide
+ * interactivity by itself: collapse state is toggled through props.
+ */
+export declare function Collapsible({ lazy, ...props }: CollapsibleProps): JSX.Element;
+export {};
+//# sourceMappingURL=index.d.ts.map

package/lib/components/Collapsible/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/Collapsible/index.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,KAAK,EAAE,EAOZ,KAAK,QAAQ,EACb,KAAK,cAAc,EACnB,KAAK,SAAS,EACf,MAAM,OAAO,CAAC;AAIf;;GAEG;AACH,wBAAgB,cAAc,CAAC,EAC7B,YAAY,GACb,EAAE;IACD,2DAA2D;IAC3D,YAAY,EAAE,OAAO,GAAG,CAAC,MAAM,OAAO,CAAC,CAAC;CACzC,GAAG;IACF,SAAS,EAAE,OAAO,CAAC;IACnB,YAAY,EAAE,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC;IAChD,eAAe,EAAE,MAAM,IAAI,CAAC;CAC7B,CAYA;AAgCD,aAAK,0BAA0B,GAAG;IAChC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAoEF,aAAK,sBAAsB,GAAG,KAAK,CAAC,WAAW,CAC7C,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,iBAAiB,GAAG,OAAO,CAAC,CAC/E,CAAC;AAaF,aAAK,oBAAoB,GAAG;IAC1B,uDAAuD;IACvD,EAAE,CAAC,EAAE,sBAAsB,CAAC;IAC5B,+BAA+B;IAC/B,SAAS,EAAE,OAAO,CAAC;IACnB,QAAQ,EAAE,SAAS,CAAC;IACpB,+DAA+D;IAC/D,SAAS,CAAC,EAAE,0BAA0B,CAAC;IACvC;;;;;OAKG;IACH,uBAAuB,CAAC,EAAE,CAAC,SAAS,EAAE,OAAO,KAAK,IAAI,CAAC;IACvD,iDAAiD;IACjD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B,CAAC;AA2DF,aAAK,gBAAgB,GAAG,oBAAoB,GAAG;IAC7C;;;;;OAKG;IACH,IAAI,EAAE,OAAO,CAAC;CACf,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,EAAC,IAAI,EAAE,GAAG,KAAK,EAAC,EAAE,gBAAgB,GAAG,GAAG,CAAC,OAAO,CAG3E"}

package/lib/components/Collapsible/index.js

@@ -0,0 +1,152 @@
+/**
+ * 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 ExecutionEnvironment from '@docusaurus/ExecutionEnvironment';
+import React, { useState, useEffect, useRef, useCallback, useLayoutEffect, } from 'react';
+const DefaultAnimationEasing = 'ease-in-out';
+/**
+ * This hook is a very thin wrapper around a `useState`.
+ */
+export function useCollapsible({ initialState, }) {
+    const [collapsed, setCollapsed] = useState(initialState ?? false);
+    const toggleCollapsed = useCallback(() => {
+        setCollapsed((expanded) => !expanded);
+    }, []);
+    return {
+        collapsed,
+        setCollapsed,
+        toggleCollapsed,
+    };
+}
+const CollapsedStyles = {
+    display: 'none',
+    overflow: 'hidden',
+    height: '0px',
+};
+const ExpandedStyles = {
+    display: 'block',
+    overflow: 'visible',
+    height: 'auto',
+};
+function applyCollapsedStyle(el, collapsed) {
+    const collapsedStyles = collapsed ? CollapsedStyles : ExpandedStyles;
+    el.style.display = collapsedStyles.display;
+    el.style.overflow = collapsedStyles.overflow;
+    el.style.height = collapsedStyles.height;
+}
+/*
+Lex111: Dynamic transition duration is used in Material design, this technique
+is good for a large number of items.
+https://material.io/archive/guidelines/motion/duration-easing.html#duration-easing-dynamic-durations
+https://github.com/mui-org/material-ui/blob/e724d98eba018e55e1a684236a2037e24bcf050c/packages/material-ui/src/styles/createTransitions.js#L40-L43
+ */
+function getAutoHeightDuration(height) {
+    const constant = height / 36;
+    return Math.round((4 + 15 * constant ** 0.25 + constant / 5) * 10);
+}
+function useCollapseAnimation({ collapsibleRef, collapsed, animation, }) {
+    const mounted = useRef(false);
+    useEffect(() => {
+        const el = collapsibleRef.current;
+        function getTransitionStyles() {
+            const height = el.scrollHeight;
+            const duration = animation?.duration ?? getAutoHeightDuration(height);
+            const easing = animation?.easing ?? DefaultAnimationEasing;
+            return {
+                transition: `height ${duration}ms ${easing}`,
+                height: `${height}px`,
+            };
+        }
+        function applyTransitionStyles() {
+            const transitionStyles = getTransitionStyles();
+            el.style.transition = transitionStyles.transition;
+            el.style.height = transitionStyles.height;
+        }
+        // On mount, we just apply styles, no animated transition
+        if (!mounted.current) {
+            applyCollapsedStyle(el, collapsed);
+            mounted.current = true;
+            return undefined;
+        }
+        el.style.willChange = 'height';
+        function startAnimation() {
+            const animationFrame = requestAnimationFrame(() => {
+                // When collapsing
+                if (collapsed) {
+                    applyTransitionStyles();
+                    requestAnimationFrame(() => {
+                        el.style.height = CollapsedStyles.height;
+                        el.style.overflow = CollapsedStyles.overflow;
+                    });
+                }
+                // When expanding
+                else {
+                    el.style.display = 'block';
+                    requestAnimationFrame(() => {
+                        applyTransitionStyles();
+                    });
+                }
+            });
+            return () => cancelAnimationFrame(animationFrame);
+        }
+        return startAnimation();
+    }, [collapsibleRef, collapsed, animation]);
+}
+/**
+ * Prevent hydration layout shift before animations are handled imperatively
+ * with JS
+ */
+function getSSRStyle(collapsed) {
+    if (ExecutionEnvironment.canUseDOM) {
+        return undefined;
+    }
+    return collapsed ? CollapsedStyles : ExpandedStyles;
+}
+function CollapsibleBase({ as: As = 'div', collapsed, children, animation, onCollapseTransitionEnd, className, disableSSRStyle, }) {
+    // any because TS is a pain for HTML element refs, see https://twitter.com/sebastienlorber/status/1412784677795110914
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const collapsibleRef = useRef(null);
+    useCollapseAnimation({ collapsibleRef, collapsed, animation });
+    return (React.createElement(As
+    // @ts-expect-error: the "too complicated type" is produced from
+    // "CollapsibleElementType" being a huge union
+    , { 
+        // @ts-expect-error: the "too complicated type" is produced from
+        // "CollapsibleElementType" being a huge union
+        ref: collapsibleRef, style: disableSSRStyle ? undefined : getSSRStyle(collapsed), onTransitionEnd: (e) => {
+            if (e.propertyName !== 'height') {
+                return;
+            }
+            applyCollapsedStyle(collapsibleRef.current, collapsed);
+            onCollapseTransitionEnd?.(collapsed);
+        }, className: className }, children));
+}
+function CollapsibleLazy({ collapsed, ...props }) {
+    const [mounted, setMounted] = useState(!collapsed);
+    // Updated in effect so that first expansion transition can work
+    const [lazyCollapsed, setLazyCollapsed] = useState(collapsed);
+    useLayoutEffect(() => {
+        if (!collapsed) {
+            setMounted(true);
+        }
+    }, [collapsed]);
+    useLayoutEffect(() => {
+        if (mounted) {
+            setLazyCollapsed(collapsed);
+        }
+    }, [mounted, collapsed]);
+    return mounted ? (React.createElement(CollapsibleBase, { ...props, collapsed: lazyCollapsed })) : null;
+}
+/**
+ * A headless component providing smooth and uniform collapsing behavior. The
+ * component will be invisible (zero height) when collapsed. Doesn't provide
+ * interactivity by itself: collapse state is toggled through props.
+ */
+export function Collapsible({ lazy, ...props }) {
+    const Comp = lazy ? CollapsibleLazy : CollapsibleBase;
+    return React.createElement(Comp, { ...props });
+}
+//# sourceMappingURL=index.js.map

package/lib/components/Collapsible/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/components/Collapsible/index.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,oBAAoB,MAAM,kCAAkC,CAAC;AACpE,OAAO,KAAK,EAAE,EACZ,QAAQ,EACR,SAAS,EACT,MAAM,EACN,WAAW,EACX,eAAe,GAKhB,MAAM,OAAO,CAAC;AAEf,MAAM,sBAAsB,GAAG,aAAa,CAAC;AAE7C;;GAEG;AACH,MAAM,UAAU,cAAc,CAAC,EAC7B,YAAY,GAIb;IAKC,MAAM,CAAC,SAAS,EAAE,YAAY,CAAC,GAAG,QAAQ,CAAC,YAAY,IAAI,KAAK,CAAC,CAAC;IAElE,MAAM,eAAe,GAAG,WAAW,CAAC,GAAG,EAAE;QACvC,YAAY,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC;IACxC,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO;QACL,SAAS;QACT,YAAY;QACZ,eAAe;KAChB,CAAC;AACJ,CAAC;AAED,MAAM,eAAe,GAAG;IACtB,OAAO,EAAE,MAAM;IACf,QAAQ,EAAE,QAAQ;IAClB,MAAM,EAAE,KAAK;CACL,CAAC;AAEX,MAAM,cAAc,GAAG;IACrB,OAAO,EAAE,OAAO;IAChB,QAAQ,EAAE,SAAS;IACnB,MAAM,EAAE,MAAM;CACN,CAAC;AAEX,SAAS,mBAAmB,CAAC,EAAe,EAAE,SAAkB;IAC9D,MAAM,eAAe,GAAG,SAAS,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,cAAc,CAAC;IACrE,EAAE,CAAC,KAAK,CAAC,OAAO,GAAG,eAAe,CAAC,OAAO,CAAC;IAC3C,EAAE,CAAC,KAAK,CAAC,QAAQ,GAAG,eAAe,CAAC,QAAQ,CAAC;IAC7C,EAAE,CAAC,KAAK,CAAC,MAAM,GAAG,eAAe,CAAC,MAAM,CAAC;AAC3C,CAAC;AAED;;;;;GAKG;AACH,SAAS,qBAAqB,CAAC,MAAc;IAC3C,MAAM,QAAQ,GAAG,MAAM,GAAG,EAAE,CAAC;IAC7B,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,QAAQ,IAAI,IAAI,GAAG,QAAQ,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC;AACrE,CAAC;AAOD,SAAS,oBAAoB,CAAC,EAC5B,cAAc,EACd,SAAS,EACT,SAAS,GAKV;IACC,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IAE9B,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,EAAE,GAAG,cAAc,CAAC,OAAQ,CAAC;QAEnC,SAAS,mBAAmB;YAC1B,MAAM,MAAM,GAAG,EAAE,CAAC,YAAY,CAAC;YAC/B,MAAM,QAAQ,GAAG,SAAS,EAAE,QAAQ,IAAI,qBAAqB,CAAC,MAAM,CAAC,CAAC;YACtE,MAAM,MAAM,GAAG,SAAS,EAAE,MAAM,IAAI,sBAAsB,CAAC;YAC3D,OAAO;gBACL,UAAU,EAAE,UAAU,QAAQ,MAAM,MAAM,EAAE;gBAC5C,MAAM,EAAE,GAAG,MAAM,IAAI;aACtB,CAAC;QACJ,CAAC;QAED,SAAS,qBAAqB;YAC5B,MAAM,gBAAgB,GAAG,mBAAmB,EAAE,CAAC;YAC/C,EAAE,CAAC,KAAK,CAAC,UAAU,GAAG,gBAAgB,CAAC,UAAU,CAAC;YAClD,EAAE,CAAC,KAAK,CAAC,MAAM,GAAG,gBAAgB,CAAC,MAAM,CAAC;QAC5C,CAAC;QAED,yDAAyD;QACzD,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE;YACpB,mBAAmB,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC;YACnC,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC;YACvB,OAAO,SAAS,CAAC;SAClB;QAED,EAAE,CAAC,KAAK,CAAC,UAAU,GAAG,QAAQ,CAAC;QAE/B,SAAS,cAAc;YACrB,MAAM,cAAc,GAAG,qBAAqB,CAAC,GAAG,EAAE;gBAChD,kBAAkB;gBAClB,IAAI,SAAS,EAAE;oBACb,qBAAqB,EAAE,CAAC;oBAExB,qBAAqB,CAAC,GAAG,EAAE;wBACzB,EAAE,CAAC,KAAK,CAAC,MAAM,GAAG,eAAe,CAAC,MAAM,CAAC;wBACzC,EAAE,CAAC,KAAK,CAAC,QAAQ,GAAG,eAAe,CAAC,QAAQ,CAAC;oBAC/C,CAAC,CAAC,CAAC;iBACJ;gBACD,iBAAiB;qBACZ;oBACH,EAAE,CAAC,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;oBAC3B,qBAAqB,CAAC,GAAG,EAAE;wBACzB,qBAAqB,EAAE,CAAC;oBAC1B,CAAC,CAAC,CAAC;iBACJ;YACH,CAAC,CAAC,CAAC;YAEH,OAAO,GAAG,EAAE,CAAC,oBAAoB,CAAC,cAAc,CAAC,CAAC;QACpD,CAAC;QAED,OAAO,cAAc,EAAE,CAAC;IAC1B,CAAC,EAAE,CAAC,cAAc,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC;AAC7C,CAAC;AAMD;;;GAGG;AACH,SAAS,WAAW,CAAC,SAAkB;IACrC,IAAI,oBAAoB,CAAC,SAAS,EAAE;QAClC,OAAO,SAAS,CAAC;KAClB;IACD,OAAO,SAAS,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,cAAc,CAAC;AACtD,CAAC;AA2BD,SAAS,eAAe,CAAC,EACvB,EAAE,EAAE,EAAE,GAAG,KAAK,EACd,SAAS,EACT,QAAQ,EACR,SAAS,EACT,uBAAuB,EACvB,SAAS,EACT,eAAe,GACM;IACrB,qHAAqH;IACrH,8DAA8D;IAC9D,MAAM,cAAc,GAAG,MAAM,CAAM,IAAI,CAAC,CAAC;IAEzC,oBAAoB,CAAC,EAAC,cAAc,EAAE,SAAS,EAAE,SAAS,EAAC,CAAC,CAAC;IAE7D,OAAO,CACL,oBAAC,EAAE;IACD,gEAAgE;IAChE,8CAA8C;;QAD9C,gEAAgE;QAChE,8CAA8C;QAC9C,GAAG,EAAE,cAAc,EACnB,KAAK,EAAE,eAAe,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,SAAS,CAAC,EAC3D,eAAe,EAAE,CAAC,CAAwB,EAAE,EAAE;YAC5C,IAAI,CAAC,CAAC,YAAY,KAAK,QAAQ,EAAE;gBAC/B,OAAO;aACR;YAED,mBAAmB,CAAC,cAAc,CAAC,OAAQ,EAAE,SAAS,CAAC,CAAC;YACxD,uBAAuB,EAAE,CAAC,SAAS,CAAC,CAAC;QACvC,CAAC,EACD,SAAS,EAAE,SAAS,IACnB,QAAQ,CACN,CACN,CAAC;AACJ,CAAC;AAED,SAAS,eAAe,CAAC,EAAC,SAAS,EAAE,GAAG,KAAK,EAAuB;IAClE,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,QAAQ,CAAC,CAAC,SAAS,CAAC,CAAC;IACnD,gEAAgE;IAChE,MAAM,CAAC,aAAa,EAAE,gBAAgB,CAAC,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC;IAE9D,eAAe,CAAC,GAAG,EAAE;QACnB,IAAI,CAAC,SAAS,EAAE;YACd,UAAU,CAAC,IAAI,CAAC,CAAC;SAClB;IACH,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhB,eAAe,CAAC,GAAG,EAAE;QACnB,IAAI,OAAO,EAAE;YACX,gBAAgB,CAAC,SAAS,CAAC,CAAC;SAC7B;IACH,CAAC,EAAE,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC;IAEzB,OAAO,OAAO,CAAC,CAAC,CAAC,CACf,oBAAC,eAAe,OAAK,KAAK,EAAE,SAAS,EAAE,aAAa,GAAI,CACzD,CAAC,CAAC,CAAC,IAAI,CAAC;AACX,CAAC;AAYD;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAC,EAAC,IAAI,EAAE,GAAG,KAAK,EAAmB;IAC5D,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,eAAe,CAAC;IACtD,OAAO,oBAAC,IAAI,OAAK,KAAK,GAAI,CAAC;AAC7B,CAAC"}

package/lib/components/Details/index.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 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 ComponentProps, type ReactElement } from 'react';
+export declare type DetailsProps = {
+    /** Summary is provided as props, including the wrapping `<summary>` tag */
+    summary?: ReactElement;
+} & ComponentProps<'details'>;
+/**
+ * A mostly un-styled `<details>` element with smooth collapsing. Provides some
+ * very lightweight styles, but you should bring your UI.
+ */
+export declare function Details({ summary, children, ...props }: DetailsProps): JSX.Element;
+//# sourceMappingURL=index.d.ts.map

package/lib/components/Details/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/Details/index.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAc,EAGZ,KAAK,cAAc,EACnB,KAAK,YAAY,EAClB,MAAM,OAAO,CAAC;AAoBf,oBAAY,YAAY,GAAG;IACzB,2EAA2E;IAC3E,OAAO,CAAC,EAAE,YAAY,CAAC;CACxB,GAAG,cAAc,CAAC,SAAS,CAAC,CAAC;AAE9B;;;GAGG;AACH,wBAAgB,OAAO,CAAC,EACtB,OAAO,EACP,QAAQ,EACR,GAAG,KAAK,EACT,EAAE,YAAY,GAAG,GAAG,CAAC,OAAO,CA+D5B"}

package/lib/components/Details/index.js

@@ -0,0 +1,71 @@
+/**
+ * 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, { useRef, useState, } from 'react';
+import useIsBrowser from '@docusaurus/useIsBrowser';
+import clsx from 'clsx';
+import { useCollapsible, Collapsible } from '../Collapsible';
+import styles from './styles.module.css';
+function isInSummary(node) {
+    if (!node) {
+        return false;
+    }
+    return node.tagName === 'SUMMARY' || isInSummary(node.parentElement);
+}
+function hasParent(node, parent) {
+    if (!node) {
+        return false;
+    }
+    return node === parent || hasParent(node.parentElement, parent);
+}
+/**
+ * A mostly un-styled `<details>` element with smooth collapsing. Provides some
+ * very lightweight styles, but you should bring your UI.
+ */
+export function Details({ summary, children, ...props }) {
+    const isBrowser = useIsBrowser();
+    const detailsRef = useRef(null);
+    const { collapsed, setCollapsed } = useCollapsible({
+        initialState: !props.open,
+    });
+    // Use a separate state for the actual details prop, because it must be set
+    // only after animation completes, otherwise close animations won't work
+    const [open, setOpen] = useState(props.open);
+    return (
+    // eslint-disable-next-line jsx-a11y/click-events-have-key-events, jsx-a11y/no-noninteractive-element-interactions
+    React.createElement("details", { ...props, ref: detailsRef, open: open, "data-collapsed": collapsed, className: clsx(styles.details, isBrowser && styles.isBrowser, props.className), onMouseDown: (e) => {
+            const target = e.target;
+            // Prevent a double-click to highlight summary text
+            if (isInSummary(target) && e.detail > 1) {
+                e.preventDefault();
+            }
+        }, onClick: (e) => {
+            e.stopPropagation(); // For isolation of multiple nested details/summary
+            const target = e.target;
+            const shouldToggle = isInSummary(target) && hasParent(target, detailsRef.current);
+            if (!shouldToggle) {
+                return;
+            }
+            e.preventDefault();
+            if (collapsed) {
+                setCollapsed(false);
+                setOpen(true);
+            }
+            else {
+                setCollapsed(true);
+                // Don't do this, it breaks close animation!
+                // setOpen(false);
+            }
+        } },
+        summary || React.createElement("summary", null, "Details"),
+        React.createElement(Collapsible, { lazy: false, collapsed: collapsed, disableSSRStyle // Allows component to work fine even with JS disabled!
+            : true, onCollapseTransitionEnd: (newCollapsed) => {
+                setCollapsed(newCollapsed);
+                setOpen(!newCollapsed);
+            } },
+            React.createElement("div", { className: styles.collapsibleContent }, children))));
+}
+//# sourceMappingURL=index.js.map

package/lib/components/Details/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/components/Details/index.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,EACZ,MAAM,EACN,QAAQ,GAGT,MAAM,OAAO,CAAC;AACf,OAAO,YAAY,MAAM,0BAA0B,CAAC;AACpD,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAC,cAAc,EAAE,WAAW,EAAC,MAAM,gBAAgB,CAAC;AAC3D,OAAO,MAAM,MAAM,qBAAqB,CAAC;AAEzC,SAAS,WAAW,CAAC,IAAwB;IAC3C,IAAI,CAAC,IAAI,EAAE;QACT,OAAO,KAAK,CAAC;KACd;IACD,OAAO,IAAI,CAAC,OAAO,KAAK,SAAS,IAAI,WAAW,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;AACvE,CAAC;AAED,SAAS,SAAS,CAAC,IAAwB,EAAE,MAAmB;IAC9D,IAAI,CAAC,IAAI,EAAE;QACT,OAAO,KAAK,CAAC;KACd;IACD,OAAO,IAAI,KAAK,MAAM,IAAI,SAAS,CAAC,IAAI,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;AAClE,CAAC;AAOD;;;GAGG;AACH,MAAM,UAAU,OAAO,CAAC,EACtB,OAAO,EACP,QAAQ,EACR,GAAG,KAAK,EACK;IACb,MAAM,SAAS,GAAG,YAAY,EAAE,CAAC;IACjC,MAAM,UAAU,GAAG,MAAM,CAAqB,IAAI,CAAC,CAAC;IAEpD,MAAM,EAAC,SAAS,EAAE,YAAY,EAAC,GAAG,cAAc,CAAC;QAC/C,YAAY,EAAE,CAAC,KAAK,CAAC,IAAI;KAC1B,CAAC,CAAC;IACH,2EAA2E;IAC3E,wEAAwE;IACxE,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAE7C,OAAO;IACL,kHAAkH;IAClH,oCACM,KAAK,EACT,GAAG,EAAE,UAAU,EACf,IAAI,EAAE,IAAI,oBACM,SAAS,EACzB,SAAS,EAAE,IAAI,CACb,MAAM,CAAC,OAAO,EACd,SAAS,IAAI,MAAM,CAAC,SAAS,EAC7B,KAAK,CAAC,SAAS,CAChB,EACD,WAAW,EAAE,CAAC,CAAC,EAAE,EAAE;YACjB,MAAM,MAAM,GAAG,CAAC,CAAC,MAAqB,CAAC;YACvC,mDAAmD;YACnD,IAAI,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;gBACvC,CAAC,CAAC,cAAc,EAAE,CAAC;aACpB;QACH,CAAC,EACD,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;YACb,CAAC,CAAC,eAAe,EAAE,CAAC,CAAC,mDAAmD;YACxE,MAAM,MAAM,GAAG,CAAC,CAAC,MAAqB,CAAC;YACvC,MAAM,YAAY,GAChB,WAAW,CAAC,MAAM,CAAC,IAAI,SAAS,CAAC,MAAM,EAAE,UAAU,CAAC,OAAQ,CAAC,CAAC;YAChE,IAAI,CAAC,YAAY,EAAE;gBACjB,OAAO;aACR;YACD,CAAC,CAAC,cAAc,EAAE,CAAC;YACnB,IAAI,SAAS,EAAE;gBACb,YAAY,CAAC,KAAK,CAAC,CAAC;gBACpB,OAAO,CAAC,IAAI,CAAC,CAAC;aACf;iBAAM;gBACL,YAAY,CAAC,IAAI,CAAC,CAAC;gBACnB,4CAA4C;gBAC5C,kBAAkB;aACnB;QACH,CAAC;QAEA,OAAO,IAAI,+CAA0B;QAEtC,oBAAC,WAAW,IACV,IAAI,EAAE,KAAK,EACX,SAAS,EAAE,SAAS,EACpB,eAAe,CAAC,uDAAuD;oBACvE,uBAAuB,EAAE,CAAC,YAAY,EAAE,EAAE;gBACxC,YAAY,CAAC,YAAY,CAAC,CAAC;gBAC3B,OAAO,CAAC,CAAC,YAAY,CAAC,CAAC;YACzB,CAAC;YACD,6BAAK,SAAS,EAAE,MAAM,CAAC,kBAAkB,IAAG,QAAQ,CAAO,CAC/C,CACN,CACX,CAAC;AACJ,CAAC"}

package/lib/components/Details/styles.module.css

@@ -0,0 +1,62 @@
+/**
+ * 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.
+ */
+
+/*
+CSS variables, meant to be overridden by final theme
+ */
+.details {
+  --docusaurus-details-summary-arrow-size: 0.38rem;
+  --docusaurus-details-transition: transform 200ms ease;
+  --docusaurus-details-decoration-color: grey;
+}
+
+.details > summary {
+  position: relative;
+  cursor: pointer;
+  list-style: none;
+  padding-left: 1rem;
+}
+
+/* TODO: deprecation, need to remove this after Safari will support `::marker` */
+.details > summary::-webkit-details-marker {
+  display: none;
+}
+
+.details > summary::before {
+  position: absolute;
+  top: 0.45rem;
+  left: 0;
+
+  /* CSS-only Arrow */
+  content: '';
+  border-width: var(--docusaurus-details-summary-arrow-size);
+  border-style: solid;
+  border-color: transparent transparent transparent
+    var(--docusaurus-details-decoration-color);
+
+  /* Arrow rotation anim */
+  transform: rotate(0deg);
+  transition: var(--docusaurus-details-transition);
+  transform-origin: calc(var(--docusaurus-details-summary-arrow-size) / 2) 50%;
+}
+
+/* When JS disabled/failed to load: we use the open property for arrow animation: */
+.details[open]:not(.isBrowser) > summary::before,
+/* When JS works: we use the data-attribute for arrow animation */
+.details[data-collapsed='false'].isBrowser > summary::before {
+  transform: rotate(90deg);
+}
+
+.collapsibleContent {
+  margin-top: 1rem;
+  border-top: 1px solid var(--docusaurus-details-decoration-color);
+  padding-top: 1rem;
+}
+
+.collapsibleContent > *:last-child {
+  margin-bottom: 0;
+}

package/lib/contexts/announcementBar.d.ts

@@ -0,0 +1,22 @@
+/**
+ * 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';
+export declare const AnnouncementBarDismissStorageKey = "docusaurus.announcement.dismiss";
+declare type ContextValue = {
+    /** Whether the announcement bar should be displayed. */
+    readonly isActive: boolean;
+    /**
+     * Callback fired when the user closes the announcement. Will be saved.
+     */
+    readonly close: () => void;
+};
+export declare function AnnouncementBarProvider({ children, }: {
+    children: ReactNode;
+}): JSX.Element;
+export declare function useAnnouncementBar(): ContextValue;
+export {};
+//# sourceMappingURL=announcementBar.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"announcementBar.d.ts","sourceRoot":"","sources":["../../src/contexts/announcementBar.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAc,EAMZ,KAAK,SAAS,EACf,MAAM,OAAO,CAAC;AAMf,eAAO,MAAM,gCAAgC,oCACV,CAAC;AAapC,aAAK,YAAY,GAAG;IAClB,wDAAwD;IACxD,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,IAAI,CAAC;CAC5B,CAAC;AA8DF,wBAAgB,uBAAuB,CAAC,EACtC,QAAQ,GACT,EAAE;IACD,QAAQ,EAAE,SAAS,CAAC;CACrB,GAAG,GAAG,CAAC,OAAO,CAGd;AAED,wBAAgB,kBAAkB,IAAI,YAAY,CAMjD"}

package/lib/{utils/announcementBarUtils.js → contexts/announcementBar.js}

@@ -4,26 +4,26 @@
  * 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, useEffect, useCallback, useMemo, useContext, createContext, } from 'react';
-import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
-import { createStorageSlot } from './storageUtils';
-import { useThemeConfig } from './useThemeConfig';
+import React, { useState, useEffect, useCallback, useMemo, useContext, } from 'react';
+import useIsBrowser from '@docusaurus/useIsBrowser';
+import { createStorageSlot } from '../utils/storageUtils';
+import { ReactContextError } from '../utils/reactUtils';
+import { useThemeConfig } from '../utils/useThemeConfig';
 export const AnnouncementBarDismissStorageKey = 'docusaurus.announcement.dismiss';
 const AnnouncementBarIdStorageKey = 'docusaurus.announcement.id';
 const AnnouncementBarDismissStorage = createStorageSlot(AnnouncementBarDismissStorageKey);
 const IdStorage = createStorageSlot(AnnouncementBarIdStorageKey);
 const isDismissedInStorage = () => AnnouncementBarDismissStorage.get() === 'true';
 const setDismissedInStorage = (bool) => AnnouncementBarDismissStorage.set(String(bool));
-const useAnnouncementBarContextValue = () => {
+const Context = React.createContext(null);
+function useContextValue() {
     const { announcementBar } = useThemeConfig();
-    const { isClient } = useDocusaurusContext();
-    const [isClosed, setClosed] = useState(() => {
-        return isClient
-            ? // On client navigation: init with localstorage value
-                isDismissedInStorage()
-            : // On server/hydration: always visible to prevent layout shifts (will be hidden with css if needed)
-                false;
-    });
+    const isBrowser = useIsBrowser();
+    const [isClosed, setClosed] = useState(() => isBrowser
+        ? // On client navigation: init with local storage value
+            isDismissedInStorage()
+        : // On server/hydration: always visible to prevent layout shifts (will be hidden with css if needed)
+            false);
     // Update state after hydration
     useEffect(() => {
         setClosed(isDismissedInStorage());
@@ -38,8 +38,9 @@ const useAnnouncementBarContextValue = () => {
         }
         const { id } = announcementBar;
         let viewedId = IdStorage.get();
-        // retrocompatibility due to spelling mistake of default id
+        // Retrocompatibility due to spelling mistake of default id
         // see https://github.com/facebook/docusaurus/issues/3338
+        // cSpell:ignore annoucement
         if (viewedId === 'annoucement-bar') {
             viewedId = 'announcement-bar';
         }
@@ -51,23 +52,21 @@ const useAnnouncementBarContextValue = () => {
         if (isNewAnnouncement || !isDismissedInStorage()) {
             setClosed(false);
         }
-    }, []);
-    return useMemo(() => {
-        return {
-            isClosed,
-            close: handleClose,
-        };
-    }, [isClosed]);
-};
-const AnnouncementBarContext = createContext(null);
-export const AnnouncementBarProvider = ({ children }) => {
-    const value = useAnnouncementBarContextValue();
-    return (React.createElement(AnnouncementBarContext.Provider, { value: value }, children));
-};
-export const useAnnouncementBar = () => {
-    const api = useContext(AnnouncementBarContext);
+    }, [announcementBar]);
+    return useMemo(() => ({
+        isActive: !!announcementBar && !isClosed,
+        close: handleClose,
+    }), [announcementBar, isClosed, handleClose]);
+}
+export function AnnouncementBarProvider({ children, }) {
+    const value = useContextValue();
+    return React.createElement(Context.Provider, { value: value }, children);
+}
+export function useAnnouncementBar() {
+    const api = useContext(Context);
     if (!api) {
-        throw new Error('useAnnouncementBar(): AnnouncementBar not found in React context: make sure to use the AnnouncementBarProvider on top of the tree');
+        throw new ReactContextError('AnnouncementBarProvider');
     }
     return api;
-};
+}
+//# sourceMappingURL=announcementBar.js.map

package/lib/contexts/announcementBar.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"announcementBar.js","sourceRoot":"","sources":["../../src/contexts/announcementBar.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,EACZ,QAAQ,EACR,SAAS,EACT,WAAW,EACX,OAAO,EACP,UAAU,GAEX,MAAM,OAAO,CAAC;AACf,OAAO,YAAY,MAAM,0BAA0B,CAAC;AACpD,OAAO,EAAC,iBAAiB,EAAC,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAC,iBAAiB,EAAC,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAC,cAAc,EAAC,MAAM,yBAAyB,CAAC;AAEvD,MAAM,CAAC,MAAM,gCAAgC,GAC3C,iCAAiC,CAAC;AACpC,MAAM,2BAA2B,GAAG,4BAA4B,CAAC;AAEjE,MAAM,6BAA6B,GAAG,iBAAiB,CACrD,gCAAgC,CACjC,CAAC;AACF,MAAM,SAAS,GAAG,iBAAiB,CAAC,2BAA2B,CAAC,CAAC;AAEjE,MAAM,oBAAoB,GAAG,GAAG,EAAE,CAChC,6BAA6B,CAAC,GAAG,EAAE,KAAK,MAAM,CAAC;AACjD,MAAM,qBAAqB,GAAG,CAAC,IAAa,EAAE,EAAE,CAC9C,6BAA6B,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;AAWlD,MAAM,OAAO,GAAG,KAAK,CAAC,aAAa,CAAsB,IAAI,CAAC,CAAC;AAE/D,SAAS,eAAe;IACtB,MAAM,EAAC,eAAe,EAAC,GAAG,cAAc,EAAE,CAAC;IAC3C,MAAM,SAAS,GAAG,YAAY,EAAE,CAAC;IAEjC,MAAM,CAAC,QAAQ,EAAE,SAAS,CAAC,GAAG,QAAQ,CAAC,GAAG,EAAE,CAC1C,SAAS;QACP,CAAC,CAAC,sDAAsD;YACtD,oBAAoB,EAAE;QACxB,CAAC,CAAC,mGAAmG;YACnG,KAAK,CACV,CAAC;IACF,+BAA+B;IAC/B,SAAS,CAAC,GAAG,EAAE;QACb,SAAS,CAAC,oBAAoB,EAAE,CAAC,CAAC;IACpC,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,MAAM,WAAW,GAAG,WAAW,CAAC,GAAG,EAAE;QACnC,qBAAqB,CAAC,IAAI,CAAC,CAAC;QAC5B,SAAS,CAAC,IAAI,CAAC,CAAC;IAClB,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,CAAC,eAAe,EAAE;YACpB,OAAO;SACR;QACD,MAAM,EAAC,EAAE,EAAC,GAAG,eAAe,CAAC;QAE7B,IAAI,QAAQ,GAAG,SAAS,CAAC,GAAG,EAAE,CAAC;QAE/B,2DAA2D;QAC3D,yDAAyD;QACzD,4BAA4B;QAC5B,IAAI,QAAQ,KAAK,iBAAiB,EAAE;YAClC,QAAQ,GAAG,kBAAkB,CAAC;SAC/B;QAED,MAAM,iBAAiB,GAAG,EAAE,KAAK,QAAQ,CAAC;QAE1C,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAElB,IAAI,iBAAiB,EAAE;YACrB,qBAAqB,CAAC,KAAK,CAAC,CAAC;SAC9B;QAED,IAAI,iBAAiB,IAAI,CAAC,oBAAoB,EAAE,EAAE;YAChD,SAAS,CAAC,KAAK,CAAC,CAAC;SAClB;IACH,CAAC,EAAE,CAAC,eAAe,CAAC,CAAC,CAAC;IAEtB,OAAO,OAAO,CACZ,GAAG,EAAE,CAAC,CAAC;QACL,QAAQ,EAAE,CAAC,CAAC,eAAe,IAAI,CAAC,QAAQ;QACxC,KAAK,EAAE,WAAW;KACnB,CAAC,EACF,CAAC,eAAe,EAAE,QAAQ,EAAE,WAAW,CAAC,CACzC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,EACtC,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,kBAAkB;IAChC,MAAM,GAAG,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IAChC,IAAI,CAAC,GAAG,EAAE;QACR,MAAM,IAAI,iBAAiB,CAAC,yBAAyB,CAAC,CAAC;KACxD;IACD,OAAO,GAAG,CAAC;AACb,CAAC"}

package/lib/contexts/colorMode.d.ts

@@ -0,0 +1,27 @@
+/**
+ * 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 = {
+    /** Current color mode. */
+    readonly colorMode: ColorMode;
+    /** Set new color mode. */
+    readonly setColorMode: (colorMode: ColorMode) => void;
+    readonly isDarkTheme: boolean;
+    readonly setLightTheme: () => void;
+    readonly setDarkTheme: () => void;
+};
+declare const ColorModes: {
+    readonly light: "light";
+    readonly dark: "dark";
+};
+export declare type ColorMode = typeof ColorModes[keyof typeof ColorModes];
+export declare function ColorModeProvider({ children, }: {
+    children: ReactNode;
+}): JSX.Element;
+export declare function useColorMode(): ContextValue;
+export {};
+//# sourceMappingURL=colorMode.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"colorMode.d.ts","sourceRoot":"","sources":["../../src/contexts/colorMode.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAc,EAOZ,KAAK,SAAS,EACf,MAAM,OAAO,CAAC;AAOf,aAAK,YAAY,GAAG;IAClB,0BAA0B;IAC1B,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,0BAA0B;IAC1B,QAAQ,CAAC,YAAY,EAAE,CAAC,SAAS,EAAE,SAAS,KAAK,IAAI,CAAC;IAGtD,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;IAC9B,QAAQ,CAAC,aAAa,EAAE,MAAM,IAAI,CAAC;IACnC,QAAQ,CAAC,YAAY,EAAE,MAAM,IAAI,CAAC;CACnC,CAAC;AAOF,QAAA,MAAM,UAAU;;;CAGN,CAAC;AAEX,oBAAY,SAAS,GAAG,OAAO,UAAU,CAAC,MAAM,OAAO,UAAU,CAAC,CAAC;AAwInE,wBAAgB,iBAAiB,CAAC,EAChC,QAAQ,GACT,EAAE;IACD,QAAQ,EAAE,SAAS,CAAC;CACrB,GAAG,GAAG,CAAC,OAAO,CAGd;AAED,wBAAgB,YAAY,IAAI,YAAY,CAS3C"}