@azerion/bunosaurus-theme-common 0.0.0-stage → 4.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/lib/components/Collapsible/index.d.ts +59 -0
- package/lib/components/Collapsible/index.d.ts.map +1 -0
- package/lib/components/Collapsible/index.js +145 -0
- package/lib/components/Collapsible/index.js.map +1 -0
- package/lib/components/Details/index.d.ts +20 -0
- package/lib/components/Details/index.d.ts.map +1 -0
- package/lib/components/Details/index.js +86 -0
- package/lib/components/Details/index.js.map +1 -0
- package/lib/components/Details/styles.module.css +66 -0
- package/lib/components/ThemedComponent/index.d.ts +31 -0
- package/lib/components/ThemedComponent/index.d.ts.map +1 -0
- package/lib/components/ThemedComponent/index.js +47 -0
- package/lib/components/ThemedComponent/index.js.map +1 -0
- package/lib/components/ThemedComponent/styles.module.css +26 -0
- package/lib/contexts/announcementBar.d.ts +21 -0
- package/lib/contexts/announcementBar.d.ts.map +1 -0
- package/lib/contexts/announcementBar.js +72 -0
- package/lib/contexts/announcementBar.js.map +1 -0
- package/lib/contexts/colorMode.d.ts +23 -0
- package/lib/contexts/colorMode.d.ts.map +1 -0
- package/lib/contexts/colorMode.js +163 -0
- package/lib/contexts/colorMode.js.map +1 -0
- package/lib/contexts/navbarMobileSidebar.d.ts +31 -0
- package/lib/contexts/navbarMobileSidebar.d.ts.map +1 -0
- package/lib/contexts/navbarMobileSidebar.js +65 -0
- package/lib/contexts/navbarMobileSidebar.js.map +1 -0
- package/lib/contexts/navbarSecondaryMenu/content.d.ts +37 -0
- package/lib/contexts/navbarSecondaryMenu/content.d.ts.map +1 -0
- package/lib/contexts/navbarSecondaryMenu/content.js +50 -0
- package/lib/contexts/navbarSecondaryMenu/content.js.map +1 -0
- package/lib/contexts/navbarSecondaryMenu/display.d.ts +24 -0
- package/lib/contexts/navbarSecondaryMenu/display.d.ts.map +1 -0
- package/lib/contexts/navbarSecondaryMenu/display.js +62 -0
- package/lib/contexts/navbarSecondaryMenu/display.js.map +1 -0
- package/lib/hooks/useBackToTopButton.d.ts +27 -0
- package/lib/hooks/useBackToTopButton.d.ts.map +1 -0
- package/lib/hooks/useBackToTopButton.js +50 -0
- package/lib/hooks/useBackToTopButton.js.map +1 -0
- package/lib/hooks/useCodeWordWrap.d.ts +15 -0
- package/lib/hooks/useCodeWordWrap.d.ts.map +1 -0
- package/lib/hooks/useCodeWordWrap.js +67 -0
- package/lib/hooks/useCodeWordWrap.js.map +1 -0
- package/lib/hooks/useHideableNavbar.d.ts +17 -0
- package/lib/hooks/useHideableNavbar.d.ts.map +1 -0
- package/lib/hooks/useHideableNavbar.js +65 -0
- package/lib/hooks/useHideableNavbar.js.map +1 -0
- package/lib/hooks/useLockBodyScroll.d.ts +12 -0
- package/lib/hooks/useLockBodyScroll.d.ts.map +1 -0
- package/lib/hooks/useLockBodyScroll.js +20 -0
- package/lib/hooks/useLockBodyScroll.js.map +1 -0
- package/lib/hooks/useMutationObserver.d.ts +4 -0
- package/lib/hooks/useMutationObserver.d.ts.map +1 -0
- package/lib/hooks/useMutationObserver.js +29 -0
- package/lib/hooks/useMutationObserver.js.map +1 -0
- package/lib/hooks/usePrismTheme.d.ts +13 -0
- package/lib/hooks/usePrismTheme.d.ts.map +1 -0
- package/lib/hooks/usePrismTheme.js +21 -0
- package/lib/hooks/usePrismTheme.js.map +1 -0
- package/lib/hooks/useTOCHighlight.d.ts +25 -0
- package/lib/hooks/useTOCHighlight.d.ts.map +1 -0
- package/lib/hooks/useTOCHighlight.js +130 -0
- package/lib/hooks/useTOCHighlight.js.map +1 -0
- package/lib/hooks/useWindowSize.d.ts +27 -0
- package/lib/hooks/useWindowSize.d.ts.map +1 -0
- package/lib/hooks/useWindowSize.js +49 -0
- package/lib/hooks/useWindowSize.js.map +1 -0
- package/lib/index.d.ts +30 -0
- package/lib/index.d.ts.map +1 -0
- package/lib/index.js +37 -0
- package/lib/index.js.map +1 -0
- package/lib/internal.d.ts +35 -0
- package/lib/internal.d.ts.map +1 -0
- package/lib/internal.js +45 -0
- package/lib/internal.js.map +1 -0
- package/lib/translations/blogTranslations.d.ts +20 -0
- package/lib/translations/blogTranslations.d.ts.map +1 -0
- package/lib/translations/blogTranslations.js +52 -0
- package/lib/translations/blogTranslations.js.map +1 -0
- package/lib/translations/contentVisibilityTranslations.d.ts +12 -0
- package/lib/translations/contentVisibilityTranslations.d.ts.map +1 -0
- package/lib/translations/contentVisibilityTranslations.js +30 -0
- package/lib/translations/contentVisibilityTranslations.js.map +1 -0
- package/lib/translations/docsTranslations.d.ts +8 -0
- package/lib/translations/docsTranslations.d.ts.map +1 -0
- package/lib/translations/docsTranslations.js +17 -0
- package/lib/translations/docsTranslations.js.map +1 -0
- package/lib/utils/IntlUtils.d.ts +2 -0
- package/lib/utils/IntlUtils.d.ts.map +1 -0
- package/lib/utils/IntlUtils.js +20 -0
- package/lib/utils/IntlUtils.js.map +1 -0
- package/lib/utils/ThemeClassNames.d.ts +99 -0
- package/lib/utils/ThemeClassNames.d.ts.map +1 -0
- package/lib/utils/ThemeClassNames.js +107 -0
- package/lib/utils/ThemeClassNames.js.map +1 -0
- package/lib/utils/accessibilityUtils.d.ts +8 -0
- package/lib/utils/accessibilityUtils.d.ts.map +1 -0
- package/lib/utils/accessibilityUtils.js +10 -0
- package/lib/utils/accessibilityUtils.js.map +1 -0
- package/lib/utils/admonitionUtils.d.ts +12 -0
- package/lib/utils/admonitionUtils.d.ts.map +1 -0
- package/lib/utils/admonitionUtils.js +32 -0
- package/lib/utils/admonitionUtils.js.map +1 -0
- package/lib/utils/anchorUtils.d.ts +16 -0
- package/lib/utils/anchorUtils.d.ts.map +1 -0
- package/lib/utils/anchorUtils.js +26 -0
- package/lib/utils/anchorUtils.js.map +1 -0
- package/lib/utils/anchorUtils.module.css +14 -0
- package/lib/utils/codeBlockUtils.d.ts +101 -0
- package/lib/utils/codeBlockUtils.d.ts.map +1 -0
- package/lib/utils/codeBlockUtils.js +310 -0
- package/lib/utils/codeBlockUtils.js.map +1 -0
- package/lib/utils/emojiUtils.d.ts +20 -0
- package/lib/utils/emojiUtils.d.ts.map +1 -0
- package/lib/utils/emojiUtils.js +32 -0
- package/lib/utils/emojiUtils.js.map +1 -0
- package/lib/utils/errorBoundaryUtils.d.ts +31 -0
- package/lib/utils/errorBoundaryUtils.d.ts.map +1 -0
- package/lib/utils/errorBoundaryUtils.js +48 -0
- package/lib/utils/errorBoundaryUtils.js.map +1 -0
- package/lib/utils/errorBoundaryUtils.module.css +16 -0
- package/lib/utils/footerUtils.d.ts +13 -0
- package/lib/utils/footerUtils.d.ts.map +1 -0
- package/lib/utils/footerUtils.js +14 -0
- package/lib/utils/footerUtils.js.map +1 -0
- package/lib/utils/historyUtils.d.ts +39 -0
- package/lib/utils/historyUtils.d.ts.map +1 -0
- package/lib/utils/historyUtils.js +148 -0
- package/lib/utils/historyUtils.js.map +1 -0
- package/lib/utils/jsUtils.d.ts +24 -0
- package/lib/utils/jsUtils.d.ts.map +1 -0
- package/lib/utils/jsUtils.js +43 -0
- package/lib/utils/jsUtils.js.map +1 -0
- package/lib/utils/metadataUtils.d.ts +38 -0
- package/lib/utils/metadataUtils.d.ts.map +1 -0
- package/lib/utils/metadataUtils.js +87 -0
- package/lib/utils/metadataUtils.js.map +1 -0
- package/lib/utils/navbarUtils.d.ts +21 -0
- package/lib/utils/navbarUtils.d.ts.map +1 -0
- package/lib/utils/navbarUtils.js +35 -0
- package/lib/utils/navbarUtils.js.map +1 -0
- package/lib/utils/reactUtils.d.ts +60 -0
- package/lib/utils/reactUtils.d.ts.map +1 -0
- package/lib/utils/reactUtils.js +91 -0
- package/lib/utils/reactUtils.js.map +1 -0
- package/lib/utils/regexpUtils.d.ts +12 -0
- package/lib/utils/regexpUtils.d.ts.map +1 -0
- package/lib/utils/regexpUtils.js +18 -0
- package/lib/utils/regexpUtils.js.map +1 -0
- package/lib/utils/routesUtils.d.ts +26 -0
- package/lib/utils/routesUtils.d.ts.map +1 -0
- package/lib/utils/routesUtils.js +54 -0
- package/lib/utils/routesUtils.js.map +1 -0
- package/lib/utils/scrollUtils.d.ts +83 -0
- package/lib/utils/scrollUtils.d.ts.map +1 -0
- package/lib/utils/scrollUtils.js +201 -0
- package/lib/utils/scrollUtils.js.map +1 -0
- package/lib/utils/searchUtils.d.ts +8 -0
- package/lib/utils/searchUtils.d.ts.map +1 -0
- package/lib/utils/searchUtils.js +8 -0
- package/lib/utils/searchUtils.js.map +1 -0
- package/lib/utils/skipToContentUtils.d.ts +20 -0
- package/lib/utils/skipToContentUtils.d.ts.map +1 -0
- package/lib/utils/skipToContentUtils.js +75 -0
- package/lib/utils/skipToContentUtils.js.map +1 -0
- package/lib/utils/storageUtils.d.ts +36 -0
- package/lib/utils/storageUtils.d.ts.map +1 -0
- package/lib/utils/storageUtils.js +193 -0
- package/lib/utils/storageUtils.js.map +1 -0
- package/lib/utils/tabsUtils.d.ts +55 -0
- package/lib/utils/tabsUtils.d.ts.map +1 -0
- package/lib/utils/tabsUtils.js +179 -0
- package/lib/utils/tabsUtils.js.map +1 -0
- package/lib/utils/tagsUtils.d.ts +20 -0
- package/lib/utils/tagsUtils.d.ts.map +1 -0
- package/lib/utils/tagsUtils.js +41 -0
- package/lib/utils/tagsUtils.js.map +1 -0
- package/lib/utils/titleFormatterUtils.d.ts +59 -0
- package/lib/utils/titleFormatterUtils.d.ts.map +1 -0
- package/lib/utils/titleFormatterUtils.js +49 -0
- package/lib/utils/titleFormatterUtils.js.map +1 -0
- package/lib/utils/tocUtils.d.ts +36 -0
- package/lib/utils/tocUtils.d.ts.map +1 -0
- package/lib/utils/tocUtils.js +84 -0
- package/lib/utils/tocUtils.js.map +1 -0
- package/lib/utils/useAlternatePageUtils.d.ts +32 -0
- package/lib/utils/useAlternatePageUtils.d.ts.map +1 -0
- package/lib/utils/useAlternatePageUtils.js +42 -0
- package/lib/utils/useAlternatePageUtils.js.map +1 -0
- package/lib/utils/useLocalPathname.d.ts +13 -0
- package/lib/utils/useLocalPathname.d.ts.map +1 -0
- package/lib/utils/useLocalPathname.js +19 -0
- package/lib/utils/useLocalPathname.js.map +1 -0
- package/lib/utils/useLocationChange.d.ts +17 -0
- package/lib/utils/useLocationChange.d.ts.map +1 -0
- package/lib/utils/useLocationChange.js +31 -0
- package/lib/utils/useLocationChange.js.map +1 -0
- package/lib/utils/usePluralForm.d.ts +21 -0
- package/lib/utils/usePluralForm.d.ts.map +1 -0
- package/lib/utils/usePluralForm.js +93 -0
- package/lib/utils/usePluralForm.js.map +1 -0
- package/lib/utils/useThemeConfig.d.ts +120 -0
- package/lib/utils/useThemeConfig.d.ts.map +1 -0
- package/lib/utils/useThemeConfig.js +14 -0
- package/lib/utils/useThemeConfig.js.map +1 -0
- package/package.json +58 -4
- package/src/components/Collapsible/index.tsx +250 -0
- package/src/components/Details/index.tsx +130 -0
- package/src/components/Details/styles.module.css +66 -0
- package/src/components/ThemedComponent/index.tsx +75 -0
- package/src/components/ThemedComponent/styles.module.css +26 -0
- package/src/contexts/announcementBar.tsx +117 -0
- package/src/contexts/colorMode.tsx +257 -0
- package/src/contexts/navbarMobileSidebar.tsx +119 -0
- package/src/contexts/navbarSecondaryMenu/content.tsx +100 -0
- package/src/contexts/navbarSecondaryMenu/display.tsx +102 -0
- package/src/hooks/useBackToTopButton.ts +73 -0
- package/src/hooks/useCodeWordWrap.ts +107 -0
- package/src/hooks/useHideableNavbar.ts +81 -0
- package/src/hooks/useLockBodyScroll.ts +21 -0
- package/src/hooks/useMutationObserver.ts +38 -0
- package/src/hooks/usePrismTheme.ts +24 -0
- package/src/hooks/useTOCHighlight.ts +189 -0
- package/src/hooks/useWindowSize.ts +67 -0
- package/src/index.ts +112 -0
- package/src/internal.ts +107 -0
- package/src/translations/blogTranslations.tsx +89 -0
- package/src/translations/contentVisibilityTranslations.tsx +51 -0
- package/src/translations/docsTranslations.tsx +28 -0
- package/src/types.d.ts +8 -0
- package/src/utils/IntlUtils.ts +27 -0
- package/src/utils/ThemeClassNames.ts +119 -0
- package/src/utils/accessibilityUtils.ts +10 -0
- package/src/utils/admonitionUtils.tsx +44 -0
- package/src/utils/anchorUtils.module.css +14 -0
- package/src/utils/anchorUtils.ts +31 -0
- package/src/utils/codeBlockUtils.tsx +494 -0
- package/src/utils/emojiUtils.ts +40 -0
- package/src/utils/errorBoundaryUtils.module.css +16 -0
- package/src/utils/errorBoundaryUtils.tsx +71 -0
- package/src/utils/footerUtils.ts +18 -0
- package/src/utils/historyUtils.ts +199 -0
- package/src/utils/jsUtils.ts +54 -0
- package/src/utils/metadataUtils.tsx +145 -0
- package/src/utils/navbarUtils.tsx +45 -0
- package/src/utils/reactUtils.tsx +120 -0
- package/src/utils/regexpUtils.ts +24 -0
- package/src/utils/routesUtils.ts +75 -0
- package/src/utils/scrollUtils.tsx +303 -0
- package/src/utils/searchUtils.ts +8 -0
- package/src/utils/skipToContentUtils.tsx +108 -0
- package/src/utils/storageUtils.ts +260 -0
- package/src/utils/tabsUtils.tsx +307 -0
- package/src/utils/tagsUtils.tsx +61 -0
- package/src/utils/titleFormatterUtils.tsx +120 -0
- package/src/utils/tocUtils.ts +119 -0
- package/src/utils/useAlternatePageUtils.ts +80 -0
- package/src/utils/useLocalPathname.ts +22 -0
- package/src/utils/useLocationChange.ts +41 -0
- package/src/utils/usePluralForm.ts +131 -0
- package/src/utils/useThemeConfig.ts +147 -0
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
import { useState, useCallback, useEffect, useRef } from 'react';
|
|
2
|
+
import { useMutationObserver } from './useMutationObserver';
|
|
3
|
+
// Callback fires when the "hidden" attribute of a tabpanel changes
|
|
4
|
+
// See https://github.com/facebook/docusaurus/pull/7485
|
|
5
|
+
function useTabBecameVisibleCallback(codeBlockRef, callback) {
|
|
6
|
+
const [hiddenTabElement, setHiddenTabElement] = useState();
|
|
7
|
+
const updateHiddenTabElement = useCallback(() => {
|
|
8
|
+
// No need to observe non-hidden tabs
|
|
9
|
+
// + we want to force a re-render when a tab becomes visible
|
|
10
|
+
setHiddenTabElement(codeBlockRef.current?.closest('[role=tabpanel][hidden]'));
|
|
11
|
+
}, [codeBlockRef, setHiddenTabElement]);
|
|
12
|
+
useEffect(() => {
|
|
13
|
+
updateHiddenTabElement();
|
|
14
|
+
}, [updateHiddenTabElement]);
|
|
15
|
+
useMutationObserver(hiddenTabElement, (mutations) => {
|
|
16
|
+
mutations.forEach((mutation) => {
|
|
17
|
+
if (mutation.type === 'attributes' &&
|
|
18
|
+
mutation.attributeName === 'hidden') {
|
|
19
|
+
callback();
|
|
20
|
+
updateHiddenTabElement();
|
|
21
|
+
}
|
|
22
|
+
});
|
|
23
|
+
}, {
|
|
24
|
+
attributes: true,
|
|
25
|
+
characterData: false,
|
|
26
|
+
childList: false,
|
|
27
|
+
subtree: false,
|
|
28
|
+
});
|
|
29
|
+
}
|
|
30
|
+
export function useCodeWordWrap() {
|
|
31
|
+
const [isEnabled, setIsEnabled] = useState(false);
|
|
32
|
+
const [isCodeScrollable, setIsCodeScrollable] = useState(false);
|
|
33
|
+
const codeBlockRef = useRef(null);
|
|
34
|
+
const toggle = useCallback(() => {
|
|
35
|
+
const codeElement = codeBlockRef.current.querySelector('code');
|
|
36
|
+
if (isEnabled) {
|
|
37
|
+
codeElement.removeAttribute('style');
|
|
38
|
+
}
|
|
39
|
+
else {
|
|
40
|
+
codeElement.style.whiteSpace = 'pre-wrap';
|
|
41
|
+
// When code wrap is enabled, we want to avoid a scrollbar in any case
|
|
42
|
+
// Ensure that very very long words/strings/tokens still wrap
|
|
43
|
+
codeElement.style.overflowWrap = 'anywhere';
|
|
44
|
+
}
|
|
45
|
+
setIsEnabled((value) => !value);
|
|
46
|
+
}, [codeBlockRef, isEnabled]);
|
|
47
|
+
const updateCodeIsScrollable = useCallback(() => {
|
|
48
|
+
const { scrollWidth, clientWidth } = codeBlockRef.current;
|
|
49
|
+
const isScrollable = scrollWidth > clientWidth ||
|
|
50
|
+
codeBlockRef.current.querySelector('code').hasAttribute('style');
|
|
51
|
+
setIsCodeScrollable(isScrollable);
|
|
52
|
+
}, [codeBlockRef]);
|
|
53
|
+
useTabBecameVisibleCallback(codeBlockRef, updateCodeIsScrollable);
|
|
54
|
+
useEffect(() => {
|
|
55
|
+
updateCodeIsScrollable();
|
|
56
|
+
}, [isEnabled, updateCodeIsScrollable]);
|
|
57
|
+
useEffect(() => {
|
|
58
|
+
window.addEventListener('resize', updateCodeIsScrollable, {
|
|
59
|
+
passive: true,
|
|
60
|
+
});
|
|
61
|
+
return () => {
|
|
62
|
+
window.removeEventListener('resize', updateCodeIsScrollable);
|
|
63
|
+
};
|
|
64
|
+
}, [updateCodeIsScrollable]);
|
|
65
|
+
return { codeBlockRef, isEnabled, isCodeScrollable, toggle };
|
|
66
|
+
}
|
|
67
|
+
//# sourceMappingURL=useCodeWordWrap.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"useCodeWordWrap.js","sourceRoot":"","sources":["../../src/hooks/useCodeWordWrap.ts"],"names":[],"mappings":"AAOA,OAAO,EAAC,QAAQ,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,EAAC,MAAM,OAAO,CAAC;AAC/D,OAAO,EAAC,mBAAmB,EAAC,MAAM,uBAAuB,CAAC;AAE1D,mEAAmE;AACnE,uDAAuD;AACvD,SAAS,2BAA2B,CAClC,YAA8C,EAC9C,QAAoB;IAEpB,MAAM,CAAC,gBAAgB,EAAE,mBAAmB,CAAC,GAAG,QAAQ,EAErD,CAAC;IAEJ,MAAM,sBAAsB,GAAG,WAAW,CAAC,GAAG,EAAE;QAC9C,qCAAqC;QACrC,4DAA4D;QAC5D,mBAAmB,CACjB,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,yBAAyB,CAAC,CACzD,CAAC;IACJ,CAAC,EAAE,CAAC,YAAY,EAAE,mBAAmB,CAAC,CAAC,CAAC;IAExC,SAAS,CAAC,GAAG,EAAE;QACb,sBAAsB,EAAE,CAAC;IAC3B,CAAC,EAAE,CAAC,sBAAsB,CAAC,CAAC,CAAC;IAE7B,mBAAmB,CACjB,gBAAgB,EAChB,CAAC,SAA2B,EAAE,EAAE;QAC9B,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;YAC7B,IACE,QAAQ,CAAC,IAAI,KAAK,YAAY;gBAC9B,QAAQ,CAAC,aAAa,KAAK,QAAQ,EACnC,CAAC;gBACD,QAAQ,EAAE,CAAC;gBACX,sBAAsB,EAAE,CAAC;YAC3B,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC,EACD;QACE,UAAU,EAAE,IAAI;QAChB,aAAa,EAAE,KAAK;QACpB,SAAS,EAAE,KAAK;QAChB,OAAO,EAAE,KAAK;KACf,CACF,CAAC;AACJ,CAAC;AASD,MAAM,UAAU,eAAe;IAC7B,MAAM,CAAC,SAAS,EAAE,YAAY,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IAClD,MAAM,CAAC,gBAAgB,EAAE,mBAAmB,CAAC,GAAG,QAAQ,CAAU,KAAK,CAAC,CAAC;IACzE,MAAM,YAAY,GAAG,MAAM,CAAiB,IAAI,CAAC,CAAC;IAElD,MAAM,MAAM,GAAG,WAAW,CAAC,GAAG,EAAE;QAC9B,MAAM,WAAW,GAAG,YAAY,CAAC,OAAQ,CAAC,aAAa,CAAC,MAAM,CAAE,CAAC;QAEjE,IAAI,SAAS,EAAE,CAAC;YACd,WAAW,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;QACvC,CAAC;aAAM,CAAC;YACN,WAAW,CAAC,KAAK,CAAC,UAAU,GAAG,UAAU,CAAC;YAC1C,sEAAsE;YACtE,6DAA6D;YAC7D,WAAW,CAAC,KAAK,CAAC,YAAY,GAAG,UAAU,CAAC;QAC9C,CAAC;QAED,YAAY,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC,EAAE,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC,CAAC;IAE9B,MAAM,sBAAsB,GAAG,WAAW,CAAC,GAAG,EAAE;QAC9C,MAAM,EAAC,WAAW,EAAE,WAAW,EAAC,GAAG,YAAY,CAAC,OAAQ,CAAC;QACzD,MAAM,YAAY,GAChB,WAAW,GAAG,WAAW;YACzB,YAAY,CAAC,OAAQ,CAAC,aAAa,CAAC,MAAM,CAAE,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QACrE,mBAAmB,CAAC,YAAY,CAAC,CAAC;IACpC,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC;IAEnB,2BAA2B,CAAC,YAAY,EAAE,sBAAsB,CAAC,CAAC;IAElE,SAAS,CAAC,GAAG,EAAE;QACb,sBAAsB,EAAE,CAAC;IAC3B,CAAC,EAAE,CAAC,SAAS,EAAE,sBAAsB,CAAC,CAAC,CAAC;IAExC,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,CAAC,gBAAgB,CAAC,QAAQ,EAAE,sBAAsB,EAAE;YACxD,OAAO,EAAE,IAAI;SACd,CAAC,CAAC;QAEH,OAAO,GAAG,EAAE;YACV,MAAM,CAAC,mBAAmB,CAAC,QAAQ,EAAE,sBAAsB,CAAC,CAAC;QAC/D,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,sBAAsB,CAAC,CAAC,CAAC;IAE7B,OAAO,EAAC,YAAY,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,EAAC,CAAC;AAC7D,CAAC"}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
3
|
+
*
|
|
4
|
+
* This source code is licensed under the MIT license found in the
|
|
5
|
+
* LICENSE file in the root directory of this source tree.
|
|
6
|
+
*/
|
|
7
|
+
/**
|
|
8
|
+
* Wires the imperative logic of a hideable navbar.
|
|
9
|
+
* @param hideOnScroll If `false`, this hook is basically a no-op.
|
|
10
|
+
*/
|
|
11
|
+
export declare function useHideableNavbar(hideOnScroll: boolean): {
|
|
12
|
+
/** A ref to the navbar component. Plug this into the actual element. */
|
|
13
|
+
readonly navbarRef: (node: HTMLElement | null) => void;
|
|
14
|
+
/** If `false`, the navbar component should not be rendered. */
|
|
15
|
+
readonly isNavbarVisible: boolean;
|
|
16
|
+
};
|
|
17
|
+
//# sourceMappingURL=useHideableNavbar.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"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,CA4DA"}
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
3
|
+
*
|
|
4
|
+
* This source code is licensed under the MIT license found in the
|
|
5
|
+
* LICENSE file in the root directory of this source tree.
|
|
6
|
+
*/
|
|
7
|
+
import { useState, useCallback, useRef } from 'react';
|
|
8
|
+
import { useLocationChange } from '../utils/useLocationChange';
|
|
9
|
+
import { useScrollPosition } from '../utils/scrollUtils';
|
|
10
|
+
/**
|
|
11
|
+
* Wires the imperative logic of a hideable navbar.
|
|
12
|
+
* @param hideOnScroll If `false`, this hook is basically a no-op.
|
|
13
|
+
*/
|
|
14
|
+
export function useHideableNavbar(hideOnScroll) {
|
|
15
|
+
const [isNavbarVisible, setIsNavbarVisible] = useState(hideOnScroll);
|
|
16
|
+
const isFocusedAnchor = useRef(false);
|
|
17
|
+
const navbarHeight = useRef(0);
|
|
18
|
+
const navbarRef = useCallback((node) => {
|
|
19
|
+
if (node !== null) {
|
|
20
|
+
navbarHeight.current = node.getBoundingClientRect().height;
|
|
21
|
+
}
|
|
22
|
+
}, []);
|
|
23
|
+
useScrollPosition(({ scrollY: scrollTop }, lastPosition) => {
|
|
24
|
+
if (!hideOnScroll) {
|
|
25
|
+
return;
|
|
26
|
+
}
|
|
27
|
+
// Needed mostly for handling rubber band scrolling.
|
|
28
|
+
// See https://github.com/facebook/docusaurus/pull/5721
|
|
29
|
+
if (scrollTop < navbarHeight.current) {
|
|
30
|
+
setIsNavbarVisible(true);
|
|
31
|
+
return;
|
|
32
|
+
}
|
|
33
|
+
if (isFocusedAnchor.current) {
|
|
34
|
+
isFocusedAnchor.current = false;
|
|
35
|
+
return;
|
|
36
|
+
}
|
|
37
|
+
const lastScrollTop = lastPosition?.scrollY;
|
|
38
|
+
const documentHeight = document.documentElement.scrollHeight - navbarHeight.current;
|
|
39
|
+
const windowHeight = window.innerHeight;
|
|
40
|
+
if (lastScrollTop && scrollTop >= lastScrollTop) {
|
|
41
|
+
setIsNavbarVisible(false);
|
|
42
|
+
}
|
|
43
|
+
else if (scrollTop + windowHeight < documentHeight) {
|
|
44
|
+
setIsNavbarVisible(true);
|
|
45
|
+
}
|
|
46
|
+
});
|
|
47
|
+
useLocationChange((locationChangeEvent) => {
|
|
48
|
+
if (!hideOnScroll) {
|
|
49
|
+
return;
|
|
50
|
+
}
|
|
51
|
+
// See https://github.com/facebook/docusaurus/pull/8059#issuecomment-1239639480
|
|
52
|
+
const currentHash = locationChangeEvent.location.hash;
|
|
53
|
+
const currentHashAnchor = currentHash
|
|
54
|
+
? document.getElementById(currentHash.substring(1))
|
|
55
|
+
: undefined;
|
|
56
|
+
if (currentHashAnchor) {
|
|
57
|
+
isFocusedAnchor.current = true;
|
|
58
|
+
setIsNavbarVisible(false);
|
|
59
|
+
return;
|
|
60
|
+
}
|
|
61
|
+
setIsNavbarVisible(true);
|
|
62
|
+
});
|
|
63
|
+
return { navbarRef, isNavbarVisible };
|
|
64
|
+
}
|
|
65
|
+
//# sourceMappingURL=useHideableNavbar.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"useHideableNavbar.js","sourceRoot":"","sources":["../../src/hooks/useHideableNavbar.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAC,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAC,MAAM,OAAO,CAAC;AACpD,OAAO,EAAC,iBAAiB,EAAC,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAAC,iBAAiB,EAAC,MAAM,sBAAsB,CAAC;AAEvD;;;GAGG;AACH,MAAM,UAAU,iBAAiB,CAAC,YAAqB;IAMrD,MAAM,CAAC,eAAe,EAAE,kBAAkB,CAAC,GAAG,QAAQ,CAAC,YAAY,CAAC,CAAC;IACrE,MAAM,eAAe,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IACtC,MAAM,YAAY,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IAC/B,MAAM,SAAS,GAAG,WAAW,CAAC,CAAC,IAAwB,EAAE,EAAE;QACzD,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YAClB,YAAY,CAAC,OAAO,GAAG,IAAI,CAAC,qBAAqB,EAAE,CAAC,MAAM,CAAC;QAC7D,CAAC;IACH,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,iBAAiB,CAAC,CAAC,EAAC,OAAO,EAAE,SAAS,EAAC,EAAE,YAAY,EAAE,EAAE;QACvD,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,OAAO;QACT,CAAC;QAED,oDAAoD;QACpD,uDAAuD;QACvD,IAAI,SAAS,GAAG,YAAY,CAAC,OAAO,EAAE,CAAC;YACrC,kBAAkB,CAAC,IAAI,CAAC,CAAC;YACzB,OAAO;QACT,CAAC;QAED,IAAI,eAAe,CAAC,OAAO,EAAE,CAAC;YAC5B,eAAe,CAAC,OAAO,GAAG,KAAK,CAAC;YAChC,OAAO;QACT,CAAC;QAED,MAAM,aAAa,GAAG,YAAY,EAAE,OAAO,CAAC;QAC5C,MAAM,cAAc,GAClB,QAAQ,CAAC,eAAe,CAAC,YAAY,GAAG,YAAY,CAAC,OAAO,CAAC;QAC/D,MAAM,YAAY,GAAG,MAAM,CAAC,WAAW,CAAC;QAExC,IAAI,aAAa,IAAI,SAAS,IAAI,aAAa,EAAE,CAAC;YAChD,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAC5B,CAAC;aAAM,IAAI,SAAS,GAAG,YAAY,GAAG,cAAc,EAAE,CAAC;YACrD,kBAAkB,CAAC,IAAI,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,iBAAiB,CAAC,CAAC,mBAAmB,EAAE,EAAE;QACxC,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,OAAO;QACT,CAAC;QAED,+EAA+E;QAC/E,MAAM,WAAW,GAAG,mBAAmB,CAAC,QAAQ,CAAC,IAAI,CAAC;QACtD,MAAM,iBAAiB,GAAG,WAAW;YACnC,CAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YACnD,CAAC,CAAC,SAAS,CAAC;QAEd,IAAI,iBAAiB,EAAE,CAAC;YACtB,eAAe,CAAC,OAAO,GAAG,IAAI,CAAC;YAC/B,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAC1B,OAAO;QACT,CAAC;QAED,kBAAkB,CAAC,IAAI,CAAC,CAAC;IAC3B,CAAC,CAAC,CAAC;IAEH,OAAO,EAAC,SAAS,EAAE,eAAe,EAAC,CAAC;AACtC,CAAC"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
3
|
+
*
|
|
4
|
+
* This source code is licensed under the MIT license found in the
|
|
5
|
+
* LICENSE file in the root directory of this source tree.
|
|
6
|
+
*/
|
|
7
|
+
/**
|
|
8
|
+
* Side-effect that locks the document body's scroll throughout the lifetime of
|
|
9
|
+
* the containing component. e.g. when the mobile sidebar is expanded.
|
|
10
|
+
*/
|
|
11
|
+
export declare function useLockBodyScroll(lock?: boolean): void;
|
|
12
|
+
//# sourceMappingURL=useLockBodyScroll.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"useLockBodyScroll.d.ts","sourceRoot":"","sources":["../../src/hooks/useLockBodyScroll.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAIH;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,GAAE,OAAc,GAAG,IAAI,CAO5D"}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
3
|
+
*
|
|
4
|
+
* This source code is licensed under the MIT license found in the
|
|
5
|
+
* LICENSE file in the root directory of this source tree.
|
|
6
|
+
*/
|
|
7
|
+
import { useEffect } from 'react';
|
|
8
|
+
/**
|
|
9
|
+
* Side-effect that locks the document body's scroll throughout the lifetime of
|
|
10
|
+
* the containing component. e.g. when the mobile sidebar is expanded.
|
|
11
|
+
*/
|
|
12
|
+
export function useLockBodyScroll(lock = true) {
|
|
13
|
+
useEffect(() => {
|
|
14
|
+
document.body.style.overflow = lock ? 'hidden' : 'visible';
|
|
15
|
+
return () => {
|
|
16
|
+
document.body.style.overflow = 'visible';
|
|
17
|
+
};
|
|
18
|
+
}, [lock]);
|
|
19
|
+
}
|
|
20
|
+
//# sourceMappingURL=useLockBodyScroll.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"useLockBodyScroll.js","sourceRoot":"","sources":["../../src/hooks/useLockBodyScroll.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAC,SAAS,EAAC,MAAM,OAAO,CAAC;AAEhC;;;GAGG;AACH,MAAM,UAAU,iBAAiB,CAAC,IAAI,GAAY,IAAI;IACpD,SAAS,CAAC,GAAG,EAAE;QACb,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;QAC3D,OAAO,GAAG,EAAE;YACV,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,SAAS,CAAC;QAC3C,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;AACb,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"useMutationObserver.d.ts","sourceRoot":"","sources":["../../src/hooks/useMutationObserver.ts"],"names":[],"mappings":"AASA,KAAK,OAAO,GAAG,oBAAoB,CAAC;AASpC,wBAAgB,mBAAmB,CACjC,MAAM,EAAE,OAAO,GAAG,SAAS,GAAG,IAAI,EAClC,QAAQ,EAAE,gBAAgB,EAC1B,OAAO,GAAE,OAAwB,GAChC,IAAI,CAeN"}
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
3
|
+
*
|
|
4
|
+
* This source code is licensed under the MIT license found in the
|
|
5
|
+
* LICENSE file in the root directory of this source tree.
|
|
6
|
+
*/
|
|
7
|
+
import { useEffect } from 'react';
|
|
8
|
+
import { useEvent, useShallowMemoObject } from '../utils/reactUtils';
|
|
9
|
+
const DefaultOptions = {
|
|
10
|
+
attributes: true,
|
|
11
|
+
characterData: true,
|
|
12
|
+
childList: true,
|
|
13
|
+
subtree: true,
|
|
14
|
+
};
|
|
15
|
+
export function useMutationObserver(target, callback, options = DefaultOptions) {
|
|
16
|
+
const stableCallback = useEvent(callback);
|
|
17
|
+
// MutationObserver options are not nested much
|
|
18
|
+
// so this should be to memo options in 99%
|
|
19
|
+
// TODO handle options.attributeFilter array
|
|
20
|
+
const stableOptions = useShallowMemoObject(options);
|
|
21
|
+
useEffect(() => {
|
|
22
|
+
const observer = new MutationObserver(stableCallback);
|
|
23
|
+
if (target) {
|
|
24
|
+
observer.observe(target, stableOptions);
|
|
25
|
+
}
|
|
26
|
+
return () => observer.disconnect();
|
|
27
|
+
}, [target, stableCallback, stableOptions]);
|
|
28
|
+
}
|
|
29
|
+
//# sourceMappingURL=useMutationObserver.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"useMutationObserver.js","sourceRoot":"","sources":["../../src/hooks/useMutationObserver.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAAC,SAAS,EAAC,MAAM,OAAO,CAAC;AAChC,OAAO,EAAC,QAAQ,EAAE,oBAAoB,EAAC,MAAM,qBAAqB,CAAC;AAInE,MAAM,cAAc,GAAY;IAC9B,UAAU,EAAE,IAAI;IAChB,aAAa,EAAE,IAAI;IACnB,SAAS,EAAE,IAAI;IACf,OAAO,EAAE,IAAI;CACd,CAAC;AAEF,MAAM,UAAU,mBAAmB,CACjC,MAAkC,EAClC,QAA0B,EAC1B,OAAO,GAAY,cAAc;IAEjC,MAAM,cAAc,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAE1C,+CAA+C;IAC/C,2CAA2C;IAC3C,4CAA4C;IAC5C,MAAM,aAAa,GAAY,oBAAoB,CAAC,OAAO,CAAC,CAAC;IAE7D,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,QAAQ,GAAG,IAAI,gBAAgB,CAAC,cAAc,CAAC,CAAC;QACtD,IAAI,MAAM,EAAE,CAAC;YACX,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;QAC1C,CAAC;QACD,OAAO,GAAG,EAAE,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;IACrC,CAAC,EAAE,CAAC,MAAM,EAAE,cAAc,EAAE,aAAa,CAAC,CAAC,CAAC;AAC9C,CAAC"}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
3
|
+
*
|
|
4
|
+
* This source code is licensed under the MIT license found in the
|
|
5
|
+
* LICENSE file in the root directory of this source tree.
|
|
6
|
+
*/
|
|
7
|
+
import type { PrismTheme } from 'prism-react-renderer';
|
|
8
|
+
/**
|
|
9
|
+
* Returns a color-mode-dependent Prism theme: whatever the user specified in
|
|
10
|
+
* the config. Falls back to `palenight`.
|
|
11
|
+
*/
|
|
12
|
+
export declare function usePrismTheme(): PrismTheme;
|
|
13
|
+
//# sourceMappingURL=usePrismTheme.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"usePrismTheme.d.ts","sourceRoot":"","sources":["../../src/hooks/usePrismTheme.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAIH,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,sBAAsB,CAAC;AAErD;;;GAGG;AACH,wBAAgB,aAAa,IAAI,UAAU,CAQ1C"}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
3
|
+
*
|
|
4
|
+
* This source code is licensed under the MIT license found in the
|
|
5
|
+
* LICENSE file in the root directory of this source tree.
|
|
6
|
+
*/
|
|
7
|
+
import { useColorMode } from '../contexts/colorMode';
|
|
8
|
+
import { useThemeConfig } from '../utils/useThemeConfig';
|
|
9
|
+
/**
|
|
10
|
+
* Returns a color-mode-dependent Prism theme: whatever the user specified in
|
|
11
|
+
* the config. Falls back to `palenight`.
|
|
12
|
+
*/
|
|
13
|
+
export function usePrismTheme() {
|
|
14
|
+
const { prism } = useThemeConfig();
|
|
15
|
+
const { colorMode } = useColorMode();
|
|
16
|
+
const lightModeTheme = prism.theme;
|
|
17
|
+
const darkModeTheme = prism.darkTheme || lightModeTheme;
|
|
18
|
+
const prismTheme = colorMode === 'dark' ? darkModeTheme : lightModeTheme;
|
|
19
|
+
return prismTheme;
|
|
20
|
+
}
|
|
21
|
+
//# sourceMappingURL=usePrismTheme.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"usePrismTheme.js","sourceRoot":"","sources":["../../src/hooks/usePrismTheme.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAC,YAAY,EAAC,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAC,cAAc,EAAC,MAAM,yBAAyB,CAAC;AAGvD;;;GAGG;AACH,MAAM,UAAU,aAAa;IAC3B,MAAM,EAAC,KAAK,EAAC,GAAG,cAAc,EAAE,CAAC;IACjC,MAAM,EAAC,SAAS,EAAC,GAAG,YAAY,EAAE,CAAC;IACnC,MAAM,cAAc,GAAG,KAAK,CAAC,KAAK,CAAC;IACnC,MAAM,aAAa,GAAG,KAAK,CAAC,SAAS,IAAI,cAAc,CAAC;IACxD,MAAM,UAAU,GAAG,SAAS,KAAK,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,cAAc,CAAC;IAEzE,OAAO,UAAU,CAAC;AACpB,CAAC"}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
3
|
+
*
|
|
4
|
+
* This source code is licensed under the MIT license found in the
|
|
5
|
+
* LICENSE file in the root directory of this source tree.
|
|
6
|
+
*/
|
|
7
|
+
export type TOCHighlightConfig = {
|
|
8
|
+
/** A class name that all TOC links share. */
|
|
9
|
+
linkClassName: string;
|
|
10
|
+
/** The class name applied to the active (highlighted) link. */
|
|
11
|
+
linkActiveClassName: string;
|
|
12
|
+
/**
|
|
13
|
+
* The minimum heading level that the TOC includes. Only headings that are in
|
|
14
|
+
* this range will be eligible as "active heading".
|
|
15
|
+
*/
|
|
16
|
+
minHeadingLevel: number;
|
|
17
|
+
/** @see {@link TOCHighlightConfig.minHeadingLevel} */
|
|
18
|
+
maxHeadingLevel: number;
|
|
19
|
+
};
|
|
20
|
+
/**
|
|
21
|
+
* Side-effect that applies the active class name to the TOC heading that the
|
|
22
|
+
* user is currently viewing. Disabled when `config` is undefined.
|
|
23
|
+
*/
|
|
24
|
+
export declare function useTOCHighlight(config: TOCHighlightConfig | undefined): void;
|
|
25
|
+
//# sourceMappingURL=useTOCHighlight.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"useTOCHighlight.d.ts","sourceRoot":"","sources":["../../src/hooks/useTOCHighlight.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AA6GH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,6CAA6C;IAC7C,aAAa,EAAE,MAAM,CAAC;IACtB,+DAA+D;IAC/D,mBAAmB,EAAE,MAAM,CAAC;IAC5B;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB,sDAAsD;IACtD,eAAe,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF;;;GAGG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,kBAAkB,GAAG,SAAS,GAAG,IAAI,CAwD5E"}
|
|
@@ -0,0 +1,130 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
3
|
+
*
|
|
4
|
+
* This source code is licensed under the MIT license found in the
|
|
5
|
+
* LICENSE file in the root directory of this source tree.
|
|
6
|
+
*/
|
|
7
|
+
import { useEffect, useRef } from 'react';
|
|
8
|
+
import { useThemeConfig } from '../utils/useThemeConfig';
|
|
9
|
+
// TODO make the hardcoded theme-classic classnames configurable (or add them
|
|
10
|
+
// to ThemeClassNames?)
|
|
11
|
+
/**
|
|
12
|
+
* If the anchor has no height and is just a "marker" in the DOM; we'll use the
|
|
13
|
+
* parent (normally the link text) rect boundaries instead
|
|
14
|
+
*/
|
|
15
|
+
function getVisibleBoundingClientRect(element) {
|
|
16
|
+
const rect = element.getBoundingClientRect();
|
|
17
|
+
const hasNoHeight = rect.top === rect.bottom;
|
|
18
|
+
if (hasNoHeight) {
|
|
19
|
+
return getVisibleBoundingClientRect(element.parentNode);
|
|
20
|
+
}
|
|
21
|
+
return rect;
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* Considering we divide viewport into 2 zones of each 50vh, this returns true
|
|
25
|
+
* if an element is in the first zone (i.e., appear in viewport, near the top)
|
|
26
|
+
*/
|
|
27
|
+
function isInViewportTopHalf(boundingRect) {
|
|
28
|
+
return boundingRect.top > 0 && boundingRect.bottom < window.innerHeight / 2;
|
|
29
|
+
}
|
|
30
|
+
function getAnchors({ minHeadingLevel, maxHeadingLevel, }) {
|
|
31
|
+
const selectors = [];
|
|
32
|
+
for (let i = minHeadingLevel; i <= maxHeadingLevel; i += 1) {
|
|
33
|
+
selectors.push(`h${i}.anchor`);
|
|
34
|
+
}
|
|
35
|
+
return Array.from(document.querySelectorAll(selectors.join()));
|
|
36
|
+
}
|
|
37
|
+
function getActiveAnchor(anchors, { anchorTopOffset, }) {
|
|
38
|
+
// Naming is hard: The "nextVisibleAnchor" is the first anchor that appear
|
|
39
|
+
// under the viewport top boundary. It does not mean this anchor is visible
|
|
40
|
+
// yet, but if user continues scrolling down, it will be the first to become
|
|
41
|
+
// visible
|
|
42
|
+
const nextVisibleAnchor = anchors.find((anchor) => {
|
|
43
|
+
const boundingRect = getVisibleBoundingClientRect(anchor);
|
|
44
|
+
return boundingRect.top >= anchorTopOffset;
|
|
45
|
+
});
|
|
46
|
+
if (nextVisibleAnchor) {
|
|
47
|
+
const boundingRect = getVisibleBoundingClientRect(nextVisibleAnchor);
|
|
48
|
+
// If anchor is in the top half of the viewport: it is the one we consider
|
|
49
|
+
// "active" (unless it's too close to the top and and soon to be scrolled
|
|
50
|
+
// outside viewport)
|
|
51
|
+
if (isInViewportTopHalf(boundingRect)) {
|
|
52
|
+
return nextVisibleAnchor;
|
|
53
|
+
}
|
|
54
|
+
// If anchor is in the bottom half of the viewport, or under the viewport,
|
|
55
|
+
// we consider the active anchor is the previous one. This is because the
|
|
56
|
+
// main text appearing in the user screen mostly belong to the previous
|
|
57
|
+
// anchor. Returns null for the first anchor, see
|
|
58
|
+
// https://github.com/facebook/docusaurus/issues/5318
|
|
59
|
+
return anchors[anchors.indexOf(nextVisibleAnchor) - 1] ?? null;
|
|
60
|
+
}
|
|
61
|
+
// No anchor under viewport top (i.e. we are at the bottom of the page),
|
|
62
|
+
// highlight the last anchor found
|
|
63
|
+
return anchors[anchors.length - 1] ?? null;
|
|
64
|
+
}
|
|
65
|
+
function getLinkAnchorValue(link) {
|
|
66
|
+
return decodeURIComponent(link.href.substring(link.href.indexOf('#') + 1));
|
|
67
|
+
}
|
|
68
|
+
function getLinks(linkClassName) {
|
|
69
|
+
return Array.from(document.getElementsByClassName(linkClassName));
|
|
70
|
+
}
|
|
71
|
+
function getNavbarHeight() {
|
|
72
|
+
// Not ideal to obtain actual height this way
|
|
73
|
+
// Using TS ! (not ?) because otherwise a bad selector would be un-noticed
|
|
74
|
+
return document.querySelector('.navbar').clientHeight;
|
|
75
|
+
}
|
|
76
|
+
function useAnchorTopOffsetRef() {
|
|
77
|
+
const anchorTopOffsetRef = useRef(0);
|
|
78
|
+
const { navbar: { hideOnScroll }, } = useThemeConfig();
|
|
79
|
+
useEffect(() => {
|
|
80
|
+
anchorTopOffsetRef.current = hideOnScroll ? 0 : getNavbarHeight();
|
|
81
|
+
}, [hideOnScroll]);
|
|
82
|
+
return anchorTopOffsetRef;
|
|
83
|
+
}
|
|
84
|
+
/**
|
|
85
|
+
* Side-effect that applies the active class name to the TOC heading that the
|
|
86
|
+
* user is currently viewing. Disabled when `config` is undefined.
|
|
87
|
+
*/
|
|
88
|
+
export function useTOCHighlight(config) {
|
|
89
|
+
const lastActiveLinkRef = useRef(undefined);
|
|
90
|
+
const anchorTopOffsetRef = useAnchorTopOffsetRef();
|
|
91
|
+
useEffect(() => {
|
|
92
|
+
if (!config) {
|
|
93
|
+
// No-op, highlighting is disabled
|
|
94
|
+
return () => { };
|
|
95
|
+
}
|
|
96
|
+
const { linkClassName, linkActiveClassName, minHeadingLevel, maxHeadingLevel, } = config;
|
|
97
|
+
function updateLinkActiveClass(link, active) {
|
|
98
|
+
if (active) {
|
|
99
|
+
if (lastActiveLinkRef.current && lastActiveLinkRef.current !== link) {
|
|
100
|
+
lastActiveLinkRef.current.classList.remove(linkActiveClassName);
|
|
101
|
+
}
|
|
102
|
+
link.classList.add(linkActiveClassName);
|
|
103
|
+
lastActiveLinkRef.current = link;
|
|
104
|
+
// link.scrollIntoView({block: 'nearest'});
|
|
105
|
+
}
|
|
106
|
+
else {
|
|
107
|
+
link.classList.remove(linkActiveClassName);
|
|
108
|
+
}
|
|
109
|
+
}
|
|
110
|
+
function updateActiveLink() {
|
|
111
|
+
const links = getLinks(linkClassName);
|
|
112
|
+
const anchors = getAnchors({ minHeadingLevel, maxHeadingLevel });
|
|
113
|
+
const activeAnchor = getActiveAnchor(anchors, {
|
|
114
|
+
anchorTopOffset: anchorTopOffsetRef.current,
|
|
115
|
+
});
|
|
116
|
+
const activeLink = links.find((link) => activeAnchor && activeAnchor.id === getLinkAnchorValue(link));
|
|
117
|
+
links.forEach((link) => {
|
|
118
|
+
updateLinkActiveClass(link, link === activeLink);
|
|
119
|
+
});
|
|
120
|
+
}
|
|
121
|
+
document.addEventListener('scroll', updateActiveLink);
|
|
122
|
+
document.addEventListener('resize', updateActiveLink);
|
|
123
|
+
updateActiveLink();
|
|
124
|
+
return () => {
|
|
125
|
+
document.removeEventListener('scroll', updateActiveLink);
|
|
126
|
+
document.removeEventListener('resize', updateActiveLink);
|
|
127
|
+
};
|
|
128
|
+
}, [config, anchorTopOffsetRef]);
|
|
129
|
+
}
|
|
130
|
+
//# sourceMappingURL=useTOCHighlight.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"useTOCHighlight.js","sourceRoot":"","sources":["../../src/hooks/useTOCHighlight.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAC,SAAS,EAAE,MAAM,EAAC,MAAM,OAAO,CAAC;AACxC,OAAO,EAAC,cAAc,EAAC,MAAM,yBAAyB,CAAC;AAEvD,6EAA6E;AAC7E,uBAAuB;AAEvB;;;GAGG;AACH,SAAS,4BAA4B,CAAC,OAAoB;IACxD,MAAM,IAAI,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAC7C,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,KAAK,IAAI,CAAC,MAAM,CAAC;IAC7C,IAAI,WAAW,EAAE,CAAC;QAChB,OAAO,4BAA4B,CAAC,OAAO,CAAC,UAAyB,CAAC,CAAC;IACzE,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;GAGG;AACH,SAAS,mBAAmB,CAAC,YAAqB;IAChD,OAAO,YAAY,CAAC,GAAG,GAAG,CAAC,IAAI,YAAY,CAAC,MAAM,GAAG,MAAM,CAAC,WAAW,GAAG,CAAC,CAAC;AAC9E,CAAC;AAED,SAAS,UAAU,CAAC,EAClB,eAAe,EACf,eAAe,GAIhB;IACC,MAAM,SAAS,GAAG,EAAE,CAAC;IACrB,KAAK,IAAI,CAAC,GAAG,eAAe,EAAE,CAAC,IAAI,eAAe,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;QAC3D,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;AACjE,CAAC;AAED,SAAS,eAAe,CACtB,OAAsB,EACtB,EACE,eAAe,GAGhB;IAED,0EAA0E;IAC1E,2EAA2E;IAC3E,4EAA4E;IAC5E,UAAU;IACV,MAAM,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;QAChD,MAAM,YAAY,GAAG,4BAA4B,CAAC,MAAM,CAAC,CAAC;QAC1D,OAAO,YAAY,CAAC,GAAG,IAAI,eAAe,CAAC;IAC7C,CAAC,CAAC,CAAC;IAEH,IAAI,iBAAiB,EAAE,CAAC;QACtB,MAAM,YAAY,GAAG,4BAA4B,CAAC,iBAAiB,CAAC,CAAC;QACrE,0EAA0E;QAC1E,yEAAyE;QACzE,oBAAoB;QACpB,IAAI,mBAAmB,CAAC,YAAY,CAAC,EAAE,CAAC;YACtC,OAAO,iBAAiB,CAAC;QAC3B,CAAC;QACD,0EAA0E;QAC1E,yEAAyE;QACzE,uEAAuE;QACvE,iDAAiD;QACjD,qDAAqD;QACrD,OAAO,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC;IACjE,CAAC;IACD,wEAAwE;IACxE,kCAAkC;IAClC,OAAO,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC;AAC7C,CAAC;AAED,SAAS,kBAAkB,CAAC,IAAuB;IACjD,OAAO,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AAC7E,CAAC;AAED,SAAS,QAAQ,CAAC,aAAqB;IACrC,OAAO,KAAK,CAAC,IAAI,CACf,QAAQ,CAAC,sBAAsB,CAAC,aAAa,CAAC,CACxB,CAAC;AAC3B,CAAC;AAED,SAAS,eAAe;IACtB,6CAA6C;IAC7C,0EAA0E;IAC1E,OAAO,QAAQ,CAAC,aAAa,CAAC,SAAS,CAAE,CAAC,YAAY,CAAC;AACzD,CAAC;AAED,SAAS,qBAAqB;IAC5B,MAAM,kBAAkB,GAAG,MAAM,CAAS,CAAC,CAAC,CAAC;IAC7C,MAAM,EACJ,MAAM,EAAE,EAAC,YAAY,EAAC,GACvB,GAAG,cAAc,EAAE,CAAC;IAErB,SAAS,CAAC,GAAG,EAAE;QACb,kBAAkB,CAAC,OAAO,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,eAAe,EAAE,CAAC;IACpE,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC;IAEnB,OAAO,kBAAkB,CAAC;AAC5B,CAAC;AAgBD;;;GAGG;AACH,MAAM,UAAU,eAAe,CAAC,MAAsC;IACpE,MAAM,iBAAiB,GAAG,MAAM,CAAgC,SAAS,CAAC,CAAC;IAE3E,MAAM,kBAAkB,GAAG,qBAAqB,EAAE,CAAC;IAEnD,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,kCAAkC;YAClC,OAAO,GAAG,EAAE,GAAE,CAAC,CAAC;QAClB,CAAC;QAED,MAAM,EACJ,aAAa,EACb,mBAAmB,EACnB,eAAe,EACf,eAAe,GAChB,GAAG,MAAM,CAAC;QAEX,SAAS,qBAAqB,CAAC,IAAuB,EAAE,MAAe;YACrE,IAAI,MAAM,EAAE,CAAC;gBACX,IAAI,iBAAiB,CAAC,OAAO,IAAI,iBAAiB,CAAC,OAAO,KAAK,IAAI,EAAE,CAAC;oBACpE,iBAAiB,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC;gBAClE,CAAC;gBACD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;gBACxC,iBAAiB,CAAC,OAAO,GAAG,IAAI,CAAC;gBACjC,2CAA2C;YAC7C,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC;YAC7C,CAAC;QACH,CAAC;QAED,SAAS,gBAAgB;YACvB,MAAM,KAAK,GAAG,QAAQ,CAAC,aAAa,CAAC,CAAC;YACtC,MAAM,OAAO,GAAG,UAAU,CAAC,EAAC,eAAe,EAAE,eAAe,EAAC,CAAC,CAAC;YAC/D,MAAM,YAAY,GAAG,eAAe,CAAC,OAAO,EAAE;gBAC5C,eAAe,EAAE,kBAAkB,CAAC,OAAO;aAC5C,CAAC,CAAC;YACH,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAC3B,CAAC,IAAI,EAAE,EAAE,CAAC,YAAY,IAAI,YAAY,CAAC,EAAE,KAAK,kBAAkB,CAAC,IAAI,CAAC,CACvE,CAAC;YAEF,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;gBACrB,qBAAqB,CAAC,IAAI,EAAE,IAAI,KAAK,UAAU,CAAC,CAAC;YACnD,CAAC,CAAC,CAAC;QACL,CAAC;QAED,QAAQ,CAAC,gBAAgB,CAAC,QAAQ,EAAE,gBAAgB,CAAC,CAAC;QACtD,QAAQ,CAAC,gBAAgB,CAAC,QAAQ,EAAE,gBAAgB,CAAC,CAAC;QAEtD,gBAAgB,EAAE,CAAC;QAEnB,OAAO,GAAG,EAAE;YACV,QAAQ,CAAC,mBAAmB,CAAC,QAAQ,EAAE,gBAAgB,CAAC,CAAC;YACzD,QAAQ,CAAC,mBAAmB,CAAC,QAAQ,EAAE,gBAAgB,CAAC,CAAC;QAC3D,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC,CAAC;AACnC,CAAC"}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
3
|
+
*
|
|
4
|
+
* This source code is licensed under the MIT license found in the
|
|
5
|
+
* LICENSE file in the root directory of this source tree.
|
|
6
|
+
*/
|
|
7
|
+
declare const windowSizes: {
|
|
8
|
+
readonly desktop: 'desktop';
|
|
9
|
+
readonly mobile: 'mobile';
|
|
10
|
+
readonly ssr: 'ssr';
|
|
11
|
+
};
|
|
12
|
+
type WindowSize = keyof typeof windowSizes;
|
|
13
|
+
/**
|
|
14
|
+
* Gets the current window size as an enum value. We don't want it to return the
|
|
15
|
+
* actual width value, so that it only re-renders once a breakpoint is crossed.
|
|
16
|
+
*
|
|
17
|
+
* It may return `"ssr"`, which is very important to handle hydration FOUC or
|
|
18
|
+
* layout shifts. You have to handle it explicitly upfront. On the server, you
|
|
19
|
+
* may need to render BOTH the mobile/desktop elements (and hide one of them
|
|
20
|
+
* with mediaquery). We don't return `undefined` on purpose, to make it more
|
|
21
|
+
* explicit.
|
|
22
|
+
*/
|
|
23
|
+
export declare function useWindowSize({ desktopBreakpoint, }?: {
|
|
24
|
+
desktopBreakpoint?: number;
|
|
25
|
+
}): WindowSize;
|
|
26
|
+
export {};
|
|
27
|
+
//# sourceMappingURL=useWindowSize.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"useWindowSize.d.ts","sourceRoot":"","sources":["../../src/hooks/useWindowSize.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAMH,QAAA,MAAM,WAAW;aACf,OAAO,EAAE,SAAS;aAClB,MAAM,EAAE,QAAQ;aAChB,GAAG,EAAE,KAAK;CACF,CAAC;AAEX,KAAK,UAAU,GAAG,MAAM,OAAO,WAAW,CAAC;AA2B3C;;;;;;;;;GASG;AACH,wBAAgB,aAAa,CAAC,EAC5B,iBAAqC,GACtC,GAAE;IACD,iBAAiB,CAAC,EAAE,MAAM,CAAC;CACvB,GAAG,UAAU,CAQlB"}
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
3
|
+
*
|
|
4
|
+
* This source code is licensed under the MIT license found in the
|
|
5
|
+
* LICENSE file in the root directory of this source tree.
|
|
6
|
+
*/
|
|
7
|
+
import { useSyncExternalStore } from 'react';
|
|
8
|
+
import ExecutionEnvironment from '@docusaurus/ExecutionEnvironment';
|
|
9
|
+
const windowSizes = {
|
|
10
|
+
desktop: 'desktop',
|
|
11
|
+
mobile: 'mobile',
|
|
12
|
+
ssr: 'ssr',
|
|
13
|
+
};
|
|
14
|
+
// Note: this value is also hardcoded in Infima
|
|
15
|
+
// Both JS and CSS must have the same value
|
|
16
|
+
// Updating this JS value alone is not enough
|
|
17
|
+
// See https://github.com/facebook/docusaurus/issues/9603
|
|
18
|
+
const DesktopBreakpoint = 996;
|
|
19
|
+
function getWindowSize(desktopBreakpoint) {
|
|
20
|
+
if (!ExecutionEnvironment.canUseDOM) {
|
|
21
|
+
throw new Error('getWindowSize() should only be called after React hydration');
|
|
22
|
+
}
|
|
23
|
+
return window.innerWidth > desktopBreakpoint
|
|
24
|
+
? windowSizes.desktop
|
|
25
|
+
: windowSizes.mobile;
|
|
26
|
+
}
|
|
27
|
+
function subscribeToWindowResize(onChange) {
|
|
28
|
+
window.addEventListener('resize', onChange);
|
|
29
|
+
return () => {
|
|
30
|
+
window.removeEventListener('resize', onChange);
|
|
31
|
+
};
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* Gets the current window size as an enum value. We don't want it to return the
|
|
35
|
+
* actual width value, so that it only re-renders once a breakpoint is crossed.
|
|
36
|
+
*
|
|
37
|
+
* It may return `"ssr"`, which is very important to handle hydration FOUC or
|
|
38
|
+
* layout shifts. You have to handle it explicitly upfront. On the server, you
|
|
39
|
+
* may need to render BOTH the mobile/desktop elements (and hide one of them
|
|
40
|
+
* with mediaquery). We don't return `undefined` on purpose, to make it more
|
|
41
|
+
* explicit.
|
|
42
|
+
*/
|
|
43
|
+
export function useWindowSize({ desktopBreakpoint = DesktopBreakpoint, } = {}) {
|
|
44
|
+
return useSyncExternalStore(subscribeToWindowResize, () => getWindowSize(desktopBreakpoint),
|
|
45
|
+
// super important to return a constant value to avoid hydration mismatch
|
|
46
|
+
// see https://github.com/facebook/docusaurus/issues/9379
|
|
47
|
+
() => windowSizes.ssr);
|
|
48
|
+
}
|
|
49
|
+
//# sourceMappingURL=useWindowSize.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"useWindowSize.js","sourceRoot":"","sources":["../../src/hooks/useWindowSize.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAC,oBAAoB,EAAC,MAAM,OAAO,CAAC;AAE3C,OAAO,oBAAoB,MAAM,kCAAkC,CAAC;AAEpE,MAAM,WAAW,GAAG;IAClB,OAAO,EAAE,SAAS;IAClB,MAAM,EAAE,QAAQ;IAChB,GAAG,EAAE,KAAK;CACF,CAAC;AAIX,+CAA+C;AAC/C,2CAA2C;AAC3C,6CAA6C;AAC7C,yDAAyD;AACzD,MAAM,iBAAiB,GAAG,GAAG,CAAC;AAE9B,SAAS,aAAa,CAAC,iBAAyB;IAC9C,IAAI,CAAC,oBAAoB,CAAC,SAAS,EAAE,CAAC;QACpC,MAAM,IAAI,KAAK,CACb,6DAA6D,CAC9D,CAAC;IACJ,CAAC;IAED,OAAO,MAAM,CAAC,UAAU,GAAG,iBAAiB;QAC1C,CAAC,CAAC,WAAW,CAAC,OAAO;QACrB,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC;AACzB,CAAC;AAED,SAAS,uBAAuB,CAAC,QAAoB;IACnD,MAAM,CAAC,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAC5C,OAAO,GAAG,EAAE;QACV,MAAM,CAAC,mBAAmB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACjD,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,aAAa,CAAC,EAC5B,iBAAiB,GAAG,iBAAiB,GACtC,GAEG,EAAE;IACJ,OAAO,oBAAoB,CACzB,uBAAuB,EACvB,GAAG,EAAE,CAAC,aAAa,CAAC,iBAAiB,CAAC;IACtC,yEAAyE;IACzE,yDAAyD;IACzD,GAAG,EAAE,CAAC,WAAW,CAAC,GAAG,CACtB,CAAC;AACJ,CAAC"}
|
package/lib/index.d.ts
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
3
|
+
*
|
|
4
|
+
* This source code is licensed under the MIT license found in the
|
|
5
|
+
* LICENSE file in the root directory of this source tree.
|
|
6
|
+
*/
|
|
7
|
+
export { useThemeConfig, type ThemeConfig, type UserThemeConfig, type Navbar, type NavbarItem, type NavbarLogo, type MultiColumnFooter, type SimpleFooter, type Footer, type FooterColumnItem, type FooterLogo, type FooterLinkItem, type ColorModeConfig, } from './utils/useThemeConfig';
|
|
8
|
+
export { default as ThemedComponent } from './components/ThemedComponent';
|
|
9
|
+
export { createStorageSlot, useStorageSlot, listStorageKeys, } from './utils/storageUtils';
|
|
10
|
+
export { usePluralForm } from './utils/usePluralForm';
|
|
11
|
+
export { useCollapsible, Collapsible } from './components/Collapsible';
|
|
12
|
+
export { ThemeClassNames } from './utils/ThemeClassNames';
|
|
13
|
+
export { prefersReducedMotion } from './utils/accessibilityUtils';
|
|
14
|
+
export { useEvent, usePrevious, composeProviders, ReactContextError, } from './utils/reactUtils';
|
|
15
|
+
export { PageMetadata, HtmlClassNameProvider } from './utils/metadataUtils';
|
|
16
|
+
export { useColorMode, type ColorMode } from './contexts/colorMode';
|
|
17
|
+
export { NavbarSecondaryMenuFiller, type NavbarSecondaryMenuComponent, } from './contexts/navbarSecondaryMenu/content';
|
|
18
|
+
export { useWindowSize } from './hooks/useWindowSize';
|
|
19
|
+
export { translateTagsPageTitle, TagsPageLinkLabel, listTagsByLetters, type TagLetterEntry, } from './utils/tagsUtils';
|
|
20
|
+
export { useAnchorTargetClassName } from './utils/anchorUtils';
|
|
21
|
+
export { isMultiColumnFooterLinks } from './utils/footerUtils';
|
|
22
|
+
export { isRegexpStringMatch } from './utils/regexpUtils';
|
|
23
|
+
export { duplicates, uniq, groupBy } from './utils/jsUtils';
|
|
24
|
+
export { usePrismTheme } from './hooks/usePrismTheme';
|
|
25
|
+
export { processAdmonitionProps } from './utils/admonitionUtils';
|
|
26
|
+
export { useHistorySelector, useQueryString, useQueryStringList, useClearQueryString, mergeSearchParams, mergeSearchStrings, } from './utils/historyUtils';
|
|
27
|
+
export { SkipToContentFallbackId, SkipToContentLink, } from './utils/skipToContentUtils';
|
|
28
|
+
export { UnlistedBannerTitle, UnlistedBannerMessage, DraftBannerTitle, DraftBannerMessage, } from './translations/contentVisibilityTranslations';
|
|
29
|
+
export { ErrorBoundaryTryAgainButton, ErrorBoundaryError, ErrorBoundaryErrorMessageFallback, ErrorCauseBoundary, } from './utils/errorBoundaryUtils';
|
|
30
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAMH,OAAO,EACL,cAAc,EACd,KAAK,WAAW,EAChB,KAAK,eAAe,EACpB,KAAK,MAAM,EACX,KAAK,UAAU,EACf,KAAK,UAAU,EACf,KAAK,iBAAiB,EACtB,KAAK,YAAY,EACjB,KAAK,MAAM,EACX,KAAK,gBAAgB,EACrB,KAAK,UAAU,EACf,KAAK,cAAc,EACnB,KAAK,eAAe,GACrB,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAC,OAAO,IAAI,eAAe,EAAC,MAAM,8BAA8B,CAAC;AAExE,OAAO,EACL,iBAAiB,EACjB,cAAc,EACd,eAAe,GAChB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC;AAEpD,OAAO,EAAC,cAAc,EAAE,WAAW,EAAC,MAAM,0BAA0B,CAAC;AAErE,OAAO,EAAC,eAAe,EAAC,MAAM,yBAAyB,CAAC;AAExD,OAAO,EAAC,oBAAoB,EAAC,MAAM,4BAA4B,CAAC;AAEhE,OAAO,EACL,QAAQ,EACR,WAAW,EACX,gBAAgB,EAChB,iBAAiB,GAClB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAC,YAAY,EAAE,qBAAqB,EAAC,MAAM,uBAAuB,CAAC;AAE1E,OAAO,EAAC,YAAY,EAAE,KAAK,SAAS,EAAC,MAAM,sBAAsB,CAAC;AAElE,OAAO,EACL,yBAAyB,EACzB,KAAK,4BAA4B,GAClC,MAAM,wCAAwC,CAAC;AAEhD,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC;AAOpD,OAAO,EACL,sBAAsB,EACtB,iBAAiB,EACjB,iBAAiB,EACjB,KAAK,cAAc,GACpB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAC,wBAAwB,EAAC,MAAM,qBAAqB,CAAC;AAE7D,OAAO,EAAC,wBAAwB,EAAC,MAAM,qBAAqB,CAAC;AAE7D,OAAO,EAAC,mBAAmB,EAAC,MAAM,qBAAqB,CAAC;AAExD,OAAO,EAAC,UAAU,EAAE,IAAI,EAAE,OAAO,EAAC,MAAM,iBAAiB,CAAC;AAE1D,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC;AAEpD,OAAO,EAAC,sBAAsB,EAAC,MAAM,yBAAyB,CAAC;AAE/D,OAAO,EACL,kBAAkB,EAClB,cAAc,EACd,kBAAkB,EAClB,mBAAmB,EACnB,iBAAiB,EACjB,kBAAkB,GACnB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EACL,uBAAuB,EACvB,iBAAiB,GAClB,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EACL,mBAAmB,EACnB,qBAAqB,EACrB,gBAAgB,EAChB,kBAAkB,GACnB,MAAM,8CAA8C,CAAC;AAEtD,OAAO,EACL,2BAA2B,EAC3B,kBAAkB,EAClB,iCAAiC,EACjC,kBAAkB,GACnB,MAAM,4BAA4B,CAAC"}
|
package/lib/index.js
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
3
|
+
*
|
|
4
|
+
* This source code is licensed under the MIT license found in the
|
|
5
|
+
* LICENSE file in the root directory of this source tree.
|
|
6
|
+
*/
|
|
7
|
+
/*
|
|
8
|
+
* APIs to document
|
|
9
|
+
*/
|
|
10
|
+
export { useThemeConfig, } from './utils/useThemeConfig';
|
|
11
|
+
export { default as ThemedComponent } from './components/ThemedComponent';
|
|
12
|
+
export { createStorageSlot, useStorageSlot, listStorageKeys, } from './utils/storageUtils';
|
|
13
|
+
export { usePluralForm } from './utils/usePluralForm';
|
|
14
|
+
export { useCollapsible, Collapsible } from './components/Collapsible';
|
|
15
|
+
export { ThemeClassNames } from './utils/ThemeClassNames';
|
|
16
|
+
export { prefersReducedMotion } from './utils/accessibilityUtils';
|
|
17
|
+
export { useEvent, usePrevious, composeProviders, ReactContextError, } from './utils/reactUtils';
|
|
18
|
+
export { PageMetadata, HtmlClassNameProvider } from './utils/metadataUtils';
|
|
19
|
+
export { useColorMode } from './contexts/colorMode';
|
|
20
|
+
export { NavbarSecondaryMenuFiller, } from './contexts/navbarSecondaryMenu/content';
|
|
21
|
+
export { useWindowSize } from './hooks/useWindowSize';
|
|
22
|
+
/*
|
|
23
|
+
* APIs kept undocumented, on purpose
|
|
24
|
+
* Note: we still guarantee retro-compatibility on those
|
|
25
|
+
*/
|
|
26
|
+
export { translateTagsPageTitle, TagsPageLinkLabel, listTagsByLetters, } from './utils/tagsUtils';
|
|
27
|
+
export { useAnchorTargetClassName } from './utils/anchorUtils';
|
|
28
|
+
export { isMultiColumnFooterLinks } from './utils/footerUtils';
|
|
29
|
+
export { isRegexpStringMatch } from './utils/regexpUtils';
|
|
30
|
+
export { duplicates, uniq, groupBy } from './utils/jsUtils';
|
|
31
|
+
export { usePrismTheme } from './hooks/usePrismTheme';
|
|
32
|
+
export { processAdmonitionProps } from './utils/admonitionUtils';
|
|
33
|
+
export { useHistorySelector, useQueryString, useQueryStringList, useClearQueryString, mergeSearchParams, mergeSearchStrings, } from './utils/historyUtils';
|
|
34
|
+
export { SkipToContentFallbackId, SkipToContentLink, } from './utils/skipToContentUtils';
|
|
35
|
+
export { UnlistedBannerTitle, UnlistedBannerMessage, DraftBannerTitle, DraftBannerMessage, } from './translations/contentVisibilityTranslations';
|
|
36
|
+
export { ErrorBoundaryTryAgainButton, ErrorBoundaryError, ErrorBoundaryErrorMessageFallback, ErrorCauseBoundary, } from './utils/errorBoundaryUtils';
|
|
37
|
+
//# sourceMappingURL=index.js.map
|
package/lib/index.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;GAEG;AAEH,OAAO,EACL,cAAc,GAaf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAC,OAAO,IAAI,eAAe,EAAC,MAAM,8BAA8B,CAAC;AAExE,OAAO,EACL,iBAAiB,EACjB,cAAc,EACd,eAAe,GAChB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC;AAEpD,OAAO,EAAC,cAAc,EAAE,WAAW,EAAC,MAAM,0BAA0B,CAAC;AAErE,OAAO,EAAC,eAAe,EAAC,MAAM,yBAAyB,CAAC;AAExD,OAAO,EAAC,oBAAoB,EAAC,MAAM,4BAA4B,CAAC;AAEhE,OAAO,EACL,QAAQ,EACR,WAAW,EACX,gBAAgB,EAChB,iBAAiB,GAClB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAC,YAAY,EAAE,qBAAqB,EAAC,MAAM,uBAAuB,CAAC;AAE1E,OAAO,EAAC,YAAY,EAAiB,MAAM,sBAAsB,CAAC;AAElE,OAAO,EACL,yBAAyB,GAE1B,MAAM,wCAAwC,CAAC;AAEhD,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC;AAEpD;;;GAGG;AAEH,OAAO,EACL,sBAAsB,EACtB,iBAAiB,EACjB,iBAAiB,GAElB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAC,wBAAwB,EAAC,MAAM,qBAAqB,CAAC;AAE7D,OAAO,EAAC,wBAAwB,EAAC,MAAM,qBAAqB,CAAC;AAE7D,OAAO,EAAC,mBAAmB,EAAC,MAAM,qBAAqB,CAAC;AAExD,OAAO,EAAC,UAAU,EAAE,IAAI,EAAE,OAAO,EAAC,MAAM,iBAAiB,CAAC;AAE1D,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC;AAEpD,OAAO,EAAC,sBAAsB,EAAC,MAAM,yBAAyB,CAAC;AAE/D,OAAO,EACL,kBAAkB,EAClB,cAAc,EACd,kBAAkB,EAClB,mBAAmB,EACnB,iBAAiB,EACjB,kBAAkB,GACnB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EACL,uBAAuB,EACvB,iBAAiB,GAClB,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EACL,mBAAmB,EACnB,qBAAqB,EACrB,gBAAgB,EAChB,kBAAkB,GACnB,MAAM,8CAA8C,CAAC;AAEtD,OAAO,EACL,2BAA2B,EAC3B,kBAAkB,EAClB,iCAAiC,EACjC,kBAAkB,GACnB,MAAM,4BAA4B,CAAC"}
|