@docusaurus/theme-common 2.0.0-beta.138b4c997 → 2.0.0-beta.14
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/lib/components/Collapsible/index.d.ts +36 -0
- package/lib/components/Collapsible/index.d.ts.map +1 -0
- package/lib/components/Collapsible/index.js +140 -0
- package/lib/components/Collapsible/index.js.map +1 -0
- package/lib/components/Details/index.d.ts +13 -0
- package/lib/components/Details/index.d.ts.map +1 -0
- package/lib/components/Details/index.js +65 -0
- package/lib/components/Details/index.js.map +1 -0
- package/lib/components/Details/styles.module.css +58 -0
- package/lib/index.d.ts +22 -3
- package/lib/index.d.ts.map +1 -0
- package/lib/index.js +16 -2
- package/lib/index.js.map +1 -0
- package/lib/utils/ThemeClassNames.d.ts +38 -12
- package/lib/utils/ThemeClassNames.d.ts.map +1 -0
- package/lib/utils/ThemeClassNames.js +38 -3
- package/lib/utils/ThemeClassNames.js.map +1 -0
- package/lib/utils/announcementBarUtils.d.ts +4 -3
- package/lib/utils/announcementBarUtils.d.ts.map +1 -0
- package/lib/utils/announcementBarUtils.js +15 -18
- package/lib/utils/announcementBarUtils.js.map +1 -0
- package/lib/utils/codeBlockUtils.d.ts +11 -0
- package/lib/utils/codeBlockUtils.d.ts.map +1 -0
- package/lib/utils/codeBlockUtils.js +120 -0
- package/lib/utils/codeBlockUtils.js.map +1 -0
- package/lib/utils/docsPreferredVersion/DocsPreferredVersionProvider.d.ts +3 -2
- package/lib/utils/docsPreferredVersion/DocsPreferredVersionProvider.d.ts.map +1 -0
- package/lib/utils/docsPreferredVersion/DocsPreferredVersionProvider.js +3 -2
- package/lib/utils/docsPreferredVersion/DocsPreferredVersionProvider.js.map +1 -0
- package/lib/utils/docsPreferredVersion/DocsPreferredVersionStorage.d.ts +1 -0
- package/lib/utils/docsPreferredVersion/DocsPreferredVersionStorage.d.ts.map +1 -0
- package/lib/utils/docsPreferredVersion/DocsPreferredVersionStorage.js +2 -3
- package/lib/utils/docsPreferredVersion/DocsPreferredVersionStorage.js.map +1 -0
- package/lib/utils/docsPreferredVersion/useDocsPreferredVersion.d.ts +12 -3
- package/lib/utils/docsPreferredVersion/useDocsPreferredVersion.d.ts.map +1 -0
- package/lib/utils/docsPreferredVersion/useDocsPreferredVersion.js +2 -2
- package/lib/utils/docsPreferredVersion/useDocsPreferredVersion.js.map +1 -0
- package/lib/utils/docsUtils.d.ts +21 -0
- package/lib/utils/docsUtils.d.ts.map +1 -0
- package/lib/utils/docsUtils.js +107 -0
- package/lib/utils/docsUtils.js.map +1 -0
- package/lib/utils/generalUtils.d.ts +7 -0
- package/lib/utils/generalUtils.d.ts.map +1 -0
- package/lib/utils/generalUtils.js +3 -2
- package/lib/utils/generalUtils.js.map +1 -0
- package/lib/utils/historyUtils.d.ts +12 -0
- package/lib/utils/historyUtils.d.ts.map +1 -0
- package/lib/utils/historyUtils.js +40 -0
- package/lib/utils/historyUtils.js.map +1 -0
- package/lib/utils/jsUtils.d.ts +20 -0
- package/lib/utils/jsUtils.d.ts.map +1 -0
- package/lib/utils/jsUtils.js +26 -0
- package/lib/utils/jsUtils.js.map +1 -0
- package/lib/utils/mobileSecondaryMenu.d.ts +21 -0
- package/lib/utils/mobileSecondaryMenu.d.ts.map +1 -0
- package/lib/utils/mobileSecondaryMenu.js +50 -0
- package/lib/utils/mobileSecondaryMenu.js.map +1 -0
- package/lib/utils/pathUtils.d.ts +1 -0
- package/lib/utils/pathUtils.d.ts.map +1 -0
- package/lib/utils/pathUtils.js +2 -3
- package/lib/utils/pathUtils.js.map +1 -0
- package/lib/utils/reactUtils.d.ts +10 -0
- package/lib/utils/reactUtils.d.ts.map +1 -0
- package/lib/utils/reactUtils.js +27 -0
- package/lib/utils/reactUtils.js.map +1 -0
- package/lib/utils/regexpUtils.d.ts +11 -0
- package/lib/utils/regexpUtils.d.ts.map +1 -0
- package/lib/utils/regexpUtils.js +17 -0
- package/lib/utils/regexpUtils.js.map +1 -0
- package/lib/utils/scrollUtils.d.ts +53 -0
- package/lib/utils/scrollUtils.d.ts.map +1 -0
- package/lib/utils/scrollUtils.js +136 -0
- package/lib/utils/scrollUtils.js.map +1 -0
- package/lib/utils/searchUtils.d.ts +1 -0
- package/lib/utils/searchUtils.d.ts.map +1 -0
- package/lib/utils/searchUtils.js +1 -0
- package/lib/utils/searchUtils.js.map +1 -0
- package/lib/utils/storageUtils.d.ts +5 -0
- package/lib/utils/storageUtils.d.ts.map +1 -0
- package/lib/utils/storageUtils.js +30 -3
- package/lib/utils/storageUtils.js.map +1 -0
- package/lib/utils/tagsUtils.d.ts +19 -0
- package/lib/utils/tagsUtils.d.ts.map +1 -0
- package/lib/utils/tagsUtils.js +34 -0
- package/lib/utils/tagsUtils.js.map +1 -0
- package/lib/utils/tocUtils.d.ts +16 -0
- package/lib/utils/tocUtils.d.ts.map +1 -0
- package/lib/utils/tocUtils.js +35 -0
- package/lib/utils/tocUtils.js.map +1 -0
- package/lib/utils/useAlternatePageUtils.d.ts +1 -0
- package/lib/utils/useAlternatePageUtils.d.ts.map +1 -0
- package/lib/utils/useAlternatePageUtils.js +1 -0
- package/lib/utils/useAlternatePageUtils.js.map +1 -0
- package/lib/utils/useContextualSearchFilters.d.ts +12 -0
- package/lib/utils/useContextualSearchFilters.d.ts.map +1 -0
- package/lib/utils/useContextualSearchFilters.js +37 -0
- package/lib/utils/useContextualSearchFilters.js.map +1 -0
- package/{src/utils/docsUtils.ts → lib/utils/useLocalPathname.d.ts} +2 -5
- package/lib/utils/useLocalPathname.d.ts.map +1 -0
- package/lib/utils/useLocalPathname.js +17 -0
- package/lib/utils/useLocalPathname.js.map +1 -0
- package/lib/utils/useLocationChange.d.ts +1 -0
- package/lib/utils/useLocationChange.d.ts.map +1 -0
- package/lib/utils/useLocationChange.js +10 -11
- package/lib/utils/useLocationChange.js.map +1 -0
- package/lib/utils/usePluralForm.d.ts +1 -0
- package/lib/utils/usePluralForm.d.ts.map +1 -0
- package/lib/utils/usePluralForm.js +2 -3
- package/lib/utils/usePluralForm.js.map +1 -0
- package/lib/utils/usePrevious.d.ts +1 -0
- package/lib/utils/usePrevious.d.ts.map +1 -0
- package/lib/utils/usePrevious.js +4 -2
- package/lib/utils/usePrevious.js.map +1 -0
- package/lib/utils/useTOCHighlight.d.ts +15 -0
- package/lib/utils/useTOCHighlight.d.ts.map +1 -0
- package/lib/utils/useTOCHighlight.js +125 -0
- package/lib/utils/useTOCHighlight.js.map +1 -0
- package/lib/utils/useThemeConfig.d.ts +33 -9
- package/lib/utils/useThemeConfig.d.ts.map +1 -0
- package/lib/utils/useThemeConfig.js +1 -0
- package/lib/utils/useThemeConfig.js.map +1 -0
- package/package.json +18 -12
- package/src/components/Collapsible/index.tsx +242 -0
- package/src/components/Details/index.tsx +94 -0
- package/src/components/Details/styles.module.css +58 -0
- package/src/index.ts +67 -3
- package/src/types.d.ts +0 -2
- package/src/utils/ThemeClassNames.ts +43 -4
- package/src/utils/announcementBarUtils.tsx +20 -15
- package/src/utils/codeBlockUtils.ts +151 -0
- package/src/utils/docsPreferredVersion/DocsPreferredVersionProvider.tsx +7 -6
- package/src/utils/docsPreferredVersion/DocsPreferredVersionStorage.ts +2 -3
- package/src/utils/docsPreferredVersion/useDocsPreferredVersion.ts +14 -14
- package/src/utils/docsUtils.tsx +185 -0
- package/src/utils/generalUtils.ts +3 -2
- package/src/utils/historyUtils.ts +50 -0
- package/src/utils/jsUtils.ts +33 -0
- package/src/utils/mobileSecondaryMenu.tsx +114 -0
- package/src/utils/pathUtils.ts +2 -3
- package/src/utils/reactUtils.tsx +34 -0
- package/src/utils/regexpUtils.ts +23 -0
- package/src/utils/scrollUtils.tsx +237 -0
- package/src/utils/storageUtils.ts +27 -4
- package/src/utils/tagsUtils.ts +48 -0
- package/src/utils/tocUtils.ts +55 -0
- package/src/utils/useContextualSearchFilters.ts +50 -0
- package/src/utils/useLocalPathname.ts +20 -0
- package/src/utils/useLocationChange.ts +10 -12
- package/src/utils/usePluralForm.ts +2 -3
- package/src/utils/usePrevious.ts +3 -2
- package/src/utils/useTOCHighlight.ts +179 -0
- package/src/utils/useThemeConfig.ts +35 -9
- package/lib/.tsbuildinfo +0 -1
- package/src/utils/__tests__/codeBlockUtils.test.ts +0 -54
- package/src/utils/__tests__/pathUtils.test.ts +0 -32
- package/tsconfig.json +0 -10
|
@@ -0,0 +1,36 @@
|
|
|
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 React, { Dispatch, SetStateAction, ReactNode } from 'react';
|
|
8
|
+
export declare type UseCollapsibleConfig = {
|
|
9
|
+
initialState: boolean | (() => boolean);
|
|
10
|
+
};
|
|
11
|
+
export declare type UseCollapsibleReturns = {
|
|
12
|
+
collapsed: boolean;
|
|
13
|
+
setCollapsed: Dispatch<SetStateAction<boolean>>;
|
|
14
|
+
toggleCollapsed: () => void;
|
|
15
|
+
};
|
|
16
|
+
export declare function useCollapsible({ initialState, }: UseCollapsibleConfig): UseCollapsibleReturns;
|
|
17
|
+
declare type CollapsibleAnimationConfig = {
|
|
18
|
+
duration?: number;
|
|
19
|
+
easing?: string;
|
|
20
|
+
};
|
|
21
|
+
declare type CollapsibleElementType = React.ElementType<Pick<React.HTMLAttributes<unknown>, 'className' | 'onTransitionEnd' | 'style'>>;
|
|
22
|
+
declare type CollapsibleBaseProps = {
|
|
23
|
+
as?: CollapsibleElementType;
|
|
24
|
+
collapsed: boolean;
|
|
25
|
+
children: ReactNode;
|
|
26
|
+
animation?: CollapsibleAnimationConfig;
|
|
27
|
+
onCollapseTransitionEnd?: (collapsed: boolean) => void;
|
|
28
|
+
className?: string;
|
|
29
|
+
disableSSRStyle?: boolean;
|
|
30
|
+
};
|
|
31
|
+
declare type CollapsibleProps = CollapsibleBaseProps & {
|
|
32
|
+
lazy: boolean;
|
|
33
|
+
};
|
|
34
|
+
export declare function Collapsible({ lazy, ...props }: CollapsibleProps): JSX.Element;
|
|
35
|
+
export {};
|
|
36
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/Collapsible/index.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,KAAK,EAAE,EAMZ,QAAQ,EACR,cAAc,EACd,SAAS,EAEV,MAAM,OAAO,CAAC;AAIf,oBAAY,oBAAoB,GAAG;IACjC,YAAY,EAAE,OAAO,GAAG,CAAC,MAAM,OAAO,CAAC,CAAC;CACzC,CAAC;AAEF,oBAAY,qBAAqB,GAAG;IAClC,SAAS,EAAE,OAAO,CAAC;IACnB,YAAY,EAAE,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC;IAChD,eAAe,EAAE,MAAM,IAAI,CAAC;CAC7B,CAAC;AAGF,wBAAgB,cAAc,CAAC,EAC7B,YAAY,GACb,EAAE,oBAAoB,GAAG,qBAAqB,CAY9C;AA+BD,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;AAUF,aAAK,oBAAoB,GAAG;IAC1B,EAAE,CAAC,EAAE,sBAAsB,CAAC;IAC5B,SAAS,EAAE,OAAO,CAAC;IACnB,QAAQ,EAAE,SAAS,CAAC;IACpB,SAAS,CAAC,EAAE,0BAA0B,CAAC;IACvC,uBAAuB,CAAC,EAAE,CAAC,SAAS,EAAE,OAAO,KAAK,IAAI,CAAC;IACvD,SAAS,CAAC,EAAE,MAAM,CAAC;IAInB,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B,CAAC;AA0DF,aAAK,gBAAgB,GAAG,oBAAoB,GAAG;IAK7C,IAAI,EAAE,OAAO,CAAC;CACf,CAAC;AAEF,wBAAgB,WAAW,CAAC,EAAC,IAAI,EAAE,GAAG,KAAK,EAAC,EAAE,gBAAgB,GAAG,GAAG,CAAC,OAAO,CAG3E"}
|
|
@@ -0,0 +1,140 @@
|
|
|
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 ExecutionEnvironment from '@docusaurus/ExecutionEnvironment';
|
|
8
|
+
import React, { useState, useEffect, useRef, useCallback, useLayoutEffect, } from 'react';
|
|
9
|
+
const DefaultAnimationEasing = 'ease-in-out';
|
|
10
|
+
// This hook just define the state
|
|
11
|
+
export function useCollapsible({ initialState, }) {
|
|
12
|
+
const [collapsed, setCollapsed] = useState(initialState !== null && initialState !== void 0 ? initialState : false);
|
|
13
|
+
const toggleCollapsed = useCallback(() => {
|
|
14
|
+
setCollapsed((expanded) => !expanded);
|
|
15
|
+
}, []);
|
|
16
|
+
return {
|
|
17
|
+
collapsed,
|
|
18
|
+
setCollapsed,
|
|
19
|
+
toggleCollapsed,
|
|
20
|
+
};
|
|
21
|
+
}
|
|
22
|
+
const CollapsedStyles = {
|
|
23
|
+
display: 'none',
|
|
24
|
+
overflow: 'hidden',
|
|
25
|
+
height: '0px',
|
|
26
|
+
};
|
|
27
|
+
const ExpandedStyles = {
|
|
28
|
+
display: 'block',
|
|
29
|
+
overflow: 'visible',
|
|
30
|
+
height: 'auto',
|
|
31
|
+
};
|
|
32
|
+
function applyCollapsedStyle(el, collapsed) {
|
|
33
|
+
const collapsedStyles = collapsed ? CollapsedStyles : ExpandedStyles;
|
|
34
|
+
el.style.display = collapsedStyles.display;
|
|
35
|
+
el.style.overflow = collapsedStyles.overflow;
|
|
36
|
+
el.style.height = collapsedStyles.height;
|
|
37
|
+
}
|
|
38
|
+
/*
|
|
39
|
+
Lex111: Dynamic transition duration is used in Material design, this technique is good for a large number of items.
|
|
40
|
+
https://material.io/archive/guidelines/motion/duration-easing.html#duration-easing-dynamic-durations
|
|
41
|
+
https://github.com/mui-org/material-ui/blob/e724d98eba018e55e1a684236a2037e24bcf050c/packages/material-ui/src/styles/createTransitions.js#L40-L43
|
|
42
|
+
*/
|
|
43
|
+
function getAutoHeightDuration(height) {
|
|
44
|
+
const constant = height / 36;
|
|
45
|
+
return Math.round((4 + 15 * constant ** 0.25 + constant / 5) * 10);
|
|
46
|
+
}
|
|
47
|
+
function useCollapseAnimation({ collapsibleRef, collapsed, animation, }) {
|
|
48
|
+
const mounted = useRef(false);
|
|
49
|
+
useEffect(() => {
|
|
50
|
+
const el = collapsibleRef.current;
|
|
51
|
+
function getTransitionStyles() {
|
|
52
|
+
var _a, _b;
|
|
53
|
+
const height = el.scrollHeight;
|
|
54
|
+
const duration = (_a = animation === null || animation === void 0 ? void 0 : animation.duration) !== null && _a !== void 0 ? _a : getAutoHeightDuration(height);
|
|
55
|
+
const easing = (_b = animation === null || animation === void 0 ? void 0 : animation.easing) !== null && _b !== void 0 ? _b : DefaultAnimationEasing;
|
|
56
|
+
return {
|
|
57
|
+
transition: `height ${duration}ms ${easing}`,
|
|
58
|
+
height: `${height}px`,
|
|
59
|
+
};
|
|
60
|
+
}
|
|
61
|
+
function applyTransitionStyles() {
|
|
62
|
+
const transitionStyles = getTransitionStyles();
|
|
63
|
+
el.style.transition = transitionStyles.transition;
|
|
64
|
+
el.style.height = transitionStyles.height;
|
|
65
|
+
}
|
|
66
|
+
// On mount, we just apply styles, no animated transition
|
|
67
|
+
if (!mounted.current) {
|
|
68
|
+
applyCollapsedStyle(el, collapsed);
|
|
69
|
+
mounted.current = true;
|
|
70
|
+
return undefined;
|
|
71
|
+
}
|
|
72
|
+
el.style.willChange = 'height';
|
|
73
|
+
function startAnimation() {
|
|
74
|
+
const animationFrame = requestAnimationFrame(() => {
|
|
75
|
+
// When collapsing
|
|
76
|
+
if (collapsed) {
|
|
77
|
+
applyTransitionStyles();
|
|
78
|
+
requestAnimationFrame(() => {
|
|
79
|
+
el.style.height = CollapsedStyles.height;
|
|
80
|
+
el.style.overflow = CollapsedStyles.overflow;
|
|
81
|
+
});
|
|
82
|
+
}
|
|
83
|
+
// When expanding
|
|
84
|
+
else {
|
|
85
|
+
el.style.display = 'block';
|
|
86
|
+
requestAnimationFrame(() => {
|
|
87
|
+
applyTransitionStyles();
|
|
88
|
+
});
|
|
89
|
+
}
|
|
90
|
+
});
|
|
91
|
+
return () => cancelAnimationFrame(animationFrame);
|
|
92
|
+
}
|
|
93
|
+
return startAnimation();
|
|
94
|
+
}, [collapsibleRef, collapsed, animation]);
|
|
95
|
+
}
|
|
96
|
+
// Prevent hydration layout shift before anims are handled imperatively with JS
|
|
97
|
+
function getSSRStyle(collapsed) {
|
|
98
|
+
if (ExecutionEnvironment.canUseDOM) {
|
|
99
|
+
return undefined;
|
|
100
|
+
}
|
|
101
|
+
return collapsed ? CollapsedStyles : ExpandedStyles;
|
|
102
|
+
}
|
|
103
|
+
function CollapsibleBase({ as: As = 'div', collapsed, children, animation, onCollapseTransitionEnd, className, disableSSRStyle, }) {
|
|
104
|
+
// any because TS is a pain for HTML element refs, see https://twitter.com/sebastienlorber/status/1412784677795110914
|
|
105
|
+
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
106
|
+
const collapsibleRef = useRef(null);
|
|
107
|
+
useCollapseAnimation({ collapsibleRef, collapsed, animation });
|
|
108
|
+
return (React.createElement(As
|
|
109
|
+
// @ts-expect-error: the "too complicated type" is produced from "CollapsibleElementType" being a huge union
|
|
110
|
+
, {
|
|
111
|
+
// @ts-expect-error: the "too complicated type" is produced from "CollapsibleElementType" being a huge union
|
|
112
|
+
ref: collapsibleRef, style: disableSSRStyle ? undefined : getSSRStyle(collapsed), onTransitionEnd: (e) => {
|
|
113
|
+
if (e.propertyName !== 'height') {
|
|
114
|
+
return;
|
|
115
|
+
}
|
|
116
|
+
applyCollapsedStyle(collapsibleRef.current, collapsed);
|
|
117
|
+
onCollapseTransitionEnd === null || onCollapseTransitionEnd === void 0 ? void 0 : onCollapseTransitionEnd(collapsed);
|
|
118
|
+
}, className: className }, children));
|
|
119
|
+
}
|
|
120
|
+
function CollapsibleLazy({ collapsed, ...props }) {
|
|
121
|
+
const [mounted, setMounted] = useState(!collapsed);
|
|
122
|
+
useLayoutEffect(() => {
|
|
123
|
+
if (!collapsed) {
|
|
124
|
+
setMounted(true);
|
|
125
|
+
}
|
|
126
|
+
}, [collapsed]);
|
|
127
|
+
// lazyCollapsed updated in effect so that the first expansion transition can work
|
|
128
|
+
const [lazyCollapsed, setLazyCollapsed] = useState(collapsed);
|
|
129
|
+
useLayoutEffect(() => {
|
|
130
|
+
if (mounted) {
|
|
131
|
+
setLazyCollapsed(collapsed);
|
|
132
|
+
}
|
|
133
|
+
}, [mounted, collapsed]);
|
|
134
|
+
return mounted ? (React.createElement(CollapsibleBase, { ...props, collapsed: lazyCollapsed })) : null;
|
|
135
|
+
}
|
|
136
|
+
export function Collapsible({ lazy, ...props }) {
|
|
137
|
+
const Comp = lazy ? CollapsibleLazy : CollapsibleBase;
|
|
138
|
+
return React.createElement(Comp, { ...props });
|
|
139
|
+
}
|
|
140
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
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,EAKX,eAAe,GAChB,MAAM,OAAO,CAAC;AAEf,MAAM,sBAAsB,GAAG,aAAa,CAAC;AAY7C,kCAAkC;AAClC,MAAM,UAAU,cAAc,CAAC,EAC7B,YAAY,GACS;IACrB,MAAM,CAAC,SAAS,EAAE,YAAY,CAAC,GAAG,QAAQ,CAAC,YAAY,aAAZ,YAAY,cAAZ,YAAY,GAAI,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;;;;GAIG;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,MAAA,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,QAAQ,mCAAI,qBAAqB,CAAC,MAAM,CAAC,CAAC;YACtE,MAAM,MAAM,GAAG,MAAA,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,MAAM,mCAAI,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,+EAA+E;AAC/E,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;AAeD,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,4GAA4G;;QAA5G,4GAA4G;QAC5G,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,aAAvB,uBAAuB,uBAAvB,uBAAuB,CAAG,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;IAEnD,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,kFAAkF;IAClF,MAAM,CAAC,aAAa,EAAE,gBAAgB,CAAC,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC;IAC9D,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;AAUD,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"}
|
|
@@ -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 { ComponentProps, ReactElement } from 'react';
|
|
8
|
+
export declare type DetailsProps = {
|
|
9
|
+
summary?: ReactElement;
|
|
10
|
+
} & ComponentProps<'details'>;
|
|
11
|
+
declare function Details({ summary, children, ...props }: DetailsProps): JSX.Element;
|
|
12
|
+
export default Details;
|
|
13
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/Details/index.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAc,EAAC,cAAc,EAAE,YAAY,EAAmB,MAAM,OAAO,CAAC;AAoB5E,oBAAY,YAAY,GAAG;IACzB,OAAO,CAAC,EAAE,YAAY,CAAC;CACxB,GAAG,cAAc,CAAC,SAAS,CAAC,CAAC;AAE9B,iBAAS,OAAO,CAAC,EAAC,OAAO,EAAE,QAAQ,EAAE,GAAG,KAAK,EAAC,EAAE,YAAY,GAAG,GAAG,CAAC,OAAO,CA4DzE;AAED,eAAe,OAAO,CAAC"}
|
|
@@ -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 React, { useRef, useState } from 'react';
|
|
8
|
+
import useIsBrowser from '@docusaurus/useIsBrowser';
|
|
9
|
+
import clsx from 'clsx';
|
|
10
|
+
import { useCollapsible, Collapsible } from '../Collapsible';
|
|
11
|
+
import styles from './styles.module.css';
|
|
12
|
+
function isInSummary(node) {
|
|
13
|
+
if (!node) {
|
|
14
|
+
return false;
|
|
15
|
+
}
|
|
16
|
+
return node.tagName === 'SUMMARY' || isInSummary(node.parentElement);
|
|
17
|
+
}
|
|
18
|
+
function hasParent(node, parent) {
|
|
19
|
+
if (!node) {
|
|
20
|
+
return false;
|
|
21
|
+
}
|
|
22
|
+
return node === parent || hasParent(node.parentElement, parent);
|
|
23
|
+
}
|
|
24
|
+
function Details({ summary, children, ...props }) {
|
|
25
|
+
const isBrowser = useIsBrowser();
|
|
26
|
+
const detailsRef = useRef(null);
|
|
27
|
+
const { collapsed, setCollapsed } = useCollapsible({
|
|
28
|
+
initialState: !props.open,
|
|
29
|
+
});
|
|
30
|
+
// We use a separate prop because it must be set only after animation completes
|
|
31
|
+
// Otherwise close anim won't work
|
|
32
|
+
const [open, setOpen] = useState(props.open);
|
|
33
|
+
return (React.createElement("details", { ...props, ref: detailsRef, open: open, "data-collapsed": collapsed, className: clsx(styles.details, { [styles.isBrowser]: isBrowser }, props.className), onMouseDown: (e) => {
|
|
34
|
+
const target = e.target;
|
|
35
|
+
// Prevent a double-click to highlight summary text
|
|
36
|
+
if (isInSummary(target) && e.detail > 1) {
|
|
37
|
+
e.preventDefault();
|
|
38
|
+
}
|
|
39
|
+
}, onClick: (e) => {
|
|
40
|
+
e.stopPropagation(); // For isolation of multiple nested details/summary
|
|
41
|
+
const target = e.target;
|
|
42
|
+
const shouldToggle = isInSummary(target) && hasParent(target, detailsRef.current);
|
|
43
|
+
if (!shouldToggle) {
|
|
44
|
+
return;
|
|
45
|
+
}
|
|
46
|
+
e.preventDefault();
|
|
47
|
+
if (collapsed) {
|
|
48
|
+
setCollapsed(false);
|
|
49
|
+
setOpen(true);
|
|
50
|
+
}
|
|
51
|
+
else {
|
|
52
|
+
setCollapsed(true);
|
|
53
|
+
// setOpen(false); // Don't do this, it breaks close animation!
|
|
54
|
+
}
|
|
55
|
+
} },
|
|
56
|
+
summary,
|
|
57
|
+
React.createElement(Collapsible, { lazy: false, collapsed: collapsed, disableSSRStyle // Allows component to work fine even with JS disabled!
|
|
58
|
+
: true, onCollapseTransitionEnd: (newCollapsed) => {
|
|
59
|
+
setCollapsed(newCollapsed);
|
|
60
|
+
setOpen(!newCollapsed);
|
|
61
|
+
} },
|
|
62
|
+
React.createElement("div", { className: styles.collapsibleContent }, children))));
|
|
63
|
+
}
|
|
64
|
+
export default Details;
|
|
65
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/components/Details/index.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,EAA+B,MAAM,EAAE,QAAQ,EAAC,MAAM,OAAO,CAAC;AAC5E,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;AAMD,SAAS,OAAO,CAAC,EAAC,OAAO,EAAE,QAAQ,EAAE,GAAG,KAAK,EAAe;IAC1D,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,+EAA+E;IAC/E,kCAAkC;IAClC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAE7C,OAAO,CACL,oCACM,KAAK,EACT,GAAG,EAAE,UAAU,EACf,IAAI,EAAE,IAAI,oBACM,SAAS,EACzB,SAAS,EAAE,IAAI,CACb,MAAM,CAAC,OAAO,EACd,EAAC,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,SAAS,EAAC,EAC/B,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,+DAA+D;aAChE;QACH,CAAC;QACA,OAAO;QAER,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;AAED,eAAe,OAAO,CAAC"}
|
|
@@ -0,0 +1,58 @@
|
|
|
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
|
+
/*
|
|
9
|
+
CSS variables, meant to be overriden by final theme
|
|
10
|
+
*/
|
|
11
|
+
.details {
|
|
12
|
+
--docusaurus-details-summary-arrow-size: 0.38rem;
|
|
13
|
+
--docusaurus-details-transition: transform 200ms ease;
|
|
14
|
+
--docusaurus-details-decoration-color: grey;
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
.details > summary {
|
|
18
|
+
position: relative;
|
|
19
|
+
cursor: pointer;
|
|
20
|
+
list-style: none;
|
|
21
|
+
padding-left: 1rem;
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
/* TODO: deprecation, need to remove this after Safari will support `::marker` */
|
|
25
|
+
.details > summary::-webkit-details-marker {
|
|
26
|
+
display: none;
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
.details > summary:before {
|
|
30
|
+
position: absolute;
|
|
31
|
+
top: 0.45rem;
|
|
32
|
+
left: 0;
|
|
33
|
+
|
|
34
|
+
/* CSS-only Arrow */
|
|
35
|
+
content: '';
|
|
36
|
+
border-width: var(--docusaurus-details-summary-arrow-size);
|
|
37
|
+
border-style: solid;
|
|
38
|
+
border-color: transparent transparent transparent
|
|
39
|
+
var(--docusaurus-details-decoration-color);
|
|
40
|
+
|
|
41
|
+
/* Arrow rotation anim */
|
|
42
|
+
transform: rotate(0deg);
|
|
43
|
+
transition: var(--docusaurus-details-transition);
|
|
44
|
+
transform-origin: calc(var(--docusaurus-details-summary-arrow-size) / 2) 50%;
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
/* When JS disabled/failed to load: we use the open property for arrow animation: */
|
|
48
|
+
.details[open]:not(.isBrowser) > summary:before,
|
|
49
|
+
/* When JS works: we use the data-attribute for arrow animation */
|
|
50
|
+
.details[data-collapsed='false'].isBrowser > summary:before {
|
|
51
|
+
transform: rotate(90deg);
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
.collapsibleContent {
|
|
55
|
+
margin-top: 1rem;
|
|
56
|
+
border-top: 1px solid var(--docusaurus-details-decoration-color);
|
|
57
|
+
padding-top: 1rem;
|
|
58
|
+
}
|
package/lib/index.d.ts
CHANGED
|
@@ -5,18 +5,37 @@
|
|
|
5
5
|
* LICENSE file in the root directory of this source tree.
|
|
6
6
|
*/
|
|
7
7
|
export { useThemeConfig } from './utils/useThemeConfig';
|
|
8
|
-
export type { ThemeConfig, Navbar, NavbarItem, NavbarLogo,
|
|
8
|
+
export type { ThemeConfig, UserThemeConfig, Navbar, NavbarItem, NavbarLogo, MultiColumnFooter, SimpleFooter, Footer, FooterLinkItem, ColorModeConfig, } from './utils/useThemeConfig';
|
|
9
9
|
export { createStorageSlot, listStorageKeys } from './utils/storageUtils';
|
|
10
10
|
export { useAlternatePageUtils } from './utils/useAlternatePageUtils';
|
|
11
|
-
export {
|
|
11
|
+
export { useContextualSearchFilters } from './utils/useContextualSearchFilters';
|
|
12
|
+
export { parseCodeBlockTitle, parseLanguage, parseLines, } from './utils/codeBlockUtils';
|
|
12
13
|
export { docVersionSearchTag, DEFAULT_SEARCH_TAG } from './utils/searchUtils';
|
|
13
|
-
export { isDocsPluginEnabled } from './utils/docsUtils';
|
|
14
|
+
export { isDocsPluginEnabled, DocsVersionProvider, useDocsVersion, useDocById, DocsSidebarProvider, useDocsSidebar, findSidebarCategory, findFirstCategoryLink, useCurrentSidebarCategory, isActiveSidebarItem, } from './utils/docsUtils';
|
|
14
15
|
export { isSamePath } from './utils/pathUtils';
|
|
15
16
|
export { useTitleFormatter } from './utils/generalUtils';
|
|
16
17
|
export { usePluralForm } from './utils/usePluralForm';
|
|
17
18
|
export { useLocationChange } from './utils/useLocationChange';
|
|
18
19
|
export { usePrevious } from './utils/usePrevious';
|
|
20
|
+
export { useCollapsible, Collapsible } from './components/Collapsible';
|
|
21
|
+
export type { UseCollapsibleConfig, UseCollapsibleReturns, } from './components/Collapsible';
|
|
22
|
+
export { default as Details } from './components/Details';
|
|
23
|
+
export type { DetailsProps } from './components/Details';
|
|
24
|
+
export { MobileSecondaryMenuProvider, MobileSecondaryMenuFiller, useMobileSecondaryMenuRenderer, } from './utils/mobileSecondaryMenu';
|
|
25
|
+
export type { MobileSecondaryMenuComponent } from './utils/mobileSecondaryMenu';
|
|
19
26
|
export { useDocsPreferredVersion, useDocsPreferredVersionByPluginId, } from './utils/docsPreferredVersion/useDocsPreferredVersion';
|
|
27
|
+
export { duplicates, uniq } from './utils/jsUtils';
|
|
20
28
|
export { DocsPreferredVersionContextProvider } from './utils/docsPreferredVersion/DocsPreferredVersionProvider';
|
|
21
29
|
export { ThemeClassNames } from './utils/ThemeClassNames';
|
|
22
30
|
export { AnnouncementBarProvider, useAnnouncementBar, } from './utils/announcementBarUtils';
|
|
31
|
+
export { useLocalPathname } from './utils/useLocalPathname';
|
|
32
|
+
export { translateTagsPageTitle, listTagsByLetters } from './utils/tagsUtils';
|
|
33
|
+
export type { TagLetterEntry } from './utils/tagsUtils';
|
|
34
|
+
export { useHistoryPopHandler } from './utils/historyUtils';
|
|
35
|
+
export { default as useTOCHighlight } from './utils/useTOCHighlight';
|
|
36
|
+
export type { TOCHighlightConfig } from './utils/useTOCHighlight';
|
|
37
|
+
export { useTOCFilter } from './utils/tocUtils';
|
|
38
|
+
export { ScrollControllerProvider, useScrollController, useScrollPosition, useScrollPositionBlocker, } from './utils/scrollUtils';
|
|
39
|
+
export { useIsomorphicLayoutEffect, useDynamicCallback, } from './utils/reactUtils';
|
|
40
|
+
export { isRegexpStringMatch } from './utils/regexpUtils';
|
|
41
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAC,cAAc,EAAC,MAAM,wBAAwB,CAAC;AAEtD,YAAY,EACV,WAAW,EACX,eAAe,EACf,MAAM,EACN,UAAU,EACV,UAAU,EACV,iBAAiB,EACjB,YAAY,EACZ,MAAM,EACN,cAAc,EACd,eAAe,GAChB,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAC,iBAAiB,EAAE,eAAe,EAAC,MAAM,sBAAsB,CAAC;AAExE,OAAO,EAAC,qBAAqB,EAAC,MAAM,+BAA+B,CAAC;AAEpE,OAAO,EAAC,0BAA0B,EAAC,MAAM,oCAAoC,CAAC;AAE9E,OAAO,EACL,mBAAmB,EACnB,aAAa,EACb,UAAU,GACX,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAC,mBAAmB,EAAE,kBAAkB,EAAC,MAAM,qBAAqB,CAAC;AAE5E,OAAO,EACL,mBAAmB,EACnB,mBAAmB,EACnB,cAAc,EACd,UAAU,EACV,mBAAmB,EACnB,cAAc,EACd,mBAAmB,EACnB,qBAAqB,EACrB,yBAAyB,EACzB,mBAAmB,GACpB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAC,UAAU,EAAC,MAAM,mBAAmB,CAAC;AAE7C,OAAO,EAAC,iBAAiB,EAAC,MAAM,sBAAsB,CAAC;AAEvD,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC;AAEpD,OAAO,EAAC,iBAAiB,EAAC,MAAM,2BAA2B,CAAC;AAE5D,OAAO,EAAC,WAAW,EAAC,MAAM,qBAAqB,CAAC;AAEhD,OAAO,EAAC,cAAc,EAAE,WAAW,EAAC,MAAM,0BAA0B,CAAC;AACrE,YAAY,EACV,oBAAoB,EACpB,qBAAqB,GACtB,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAAC,OAAO,IAAI,OAAO,EAAC,MAAM,sBAAsB,CAAC;AACxD,YAAY,EAAC,YAAY,EAAC,MAAM,sBAAsB,CAAC;AAEvD,OAAO,EACL,2BAA2B,EAC3B,yBAAyB,EACzB,8BAA8B,GAC/B,MAAM,6BAA6B,CAAC;AACrC,YAAY,EAAC,4BAA4B,EAAC,MAAM,6BAA6B,CAAC;AAE9E,OAAO,EACL,uBAAuB,EACvB,iCAAiC,GAClC,MAAM,sDAAsD,CAAC;AAE9D,OAAO,EAAC,UAAU,EAAE,IAAI,EAAC,MAAM,iBAAiB,CAAC;AAEjD,OAAO,EAAC,mCAAmC,EAAC,MAAM,2DAA2D,CAAC;AAE9G,OAAO,EAAC,eAAe,EAAC,MAAM,yBAAyB,CAAC;AAExD,OAAO,EACL,uBAAuB,EACvB,kBAAkB,GACnB,MAAM,8BAA8B,CAAC;AAEtC,OAAO,EAAC,gBAAgB,EAAC,MAAM,0BAA0B,CAAC;AAE1D,OAAO,EAAC,sBAAsB,EAAE,iBAAiB,EAAC,MAAM,mBAAmB,CAAC;AAC5E,YAAY,EAAC,cAAc,EAAC,MAAM,mBAAmB,CAAC;AAEtD,OAAO,EAAC,oBAAoB,EAAC,MAAM,sBAAsB,CAAC;AAE1D,OAAO,EAAC,OAAO,IAAI,eAAe,EAAC,MAAM,yBAAyB,CAAC;AACnE,YAAY,EAAC,kBAAkB,EAAC,MAAM,yBAAyB,CAAC;AAEhE,OAAO,EAAC,YAAY,EAAC,MAAM,kBAAkB,CAAC;AAE9C,OAAO,EACL,wBAAwB,EACxB,mBAAmB,EACnB,iBAAiB,EACjB,wBAAwB,GACzB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EACL,yBAAyB,EACzB,kBAAkB,GACnB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAC,mBAAmB,EAAC,MAAM,qBAAqB,CAAC"}
|
package/lib/index.js
CHANGED
|
@@ -7,15 +7,29 @@
|
|
|
7
7
|
export { useThemeConfig } from './utils/useThemeConfig';
|
|
8
8
|
export { createStorageSlot, listStorageKeys } from './utils/storageUtils';
|
|
9
9
|
export { useAlternatePageUtils } from './utils/useAlternatePageUtils';
|
|
10
|
-
export {
|
|
10
|
+
export { useContextualSearchFilters } from './utils/useContextualSearchFilters';
|
|
11
|
+
export { parseCodeBlockTitle, parseLanguage, parseLines, } from './utils/codeBlockUtils';
|
|
11
12
|
export { docVersionSearchTag, DEFAULT_SEARCH_TAG } from './utils/searchUtils';
|
|
12
|
-
export { isDocsPluginEnabled } from './utils/docsUtils';
|
|
13
|
+
export { isDocsPluginEnabled, DocsVersionProvider, useDocsVersion, useDocById, DocsSidebarProvider, useDocsSidebar, findSidebarCategory, findFirstCategoryLink, useCurrentSidebarCategory, isActiveSidebarItem, } from './utils/docsUtils';
|
|
13
14
|
export { isSamePath } from './utils/pathUtils';
|
|
14
15
|
export { useTitleFormatter } from './utils/generalUtils';
|
|
15
16
|
export { usePluralForm } from './utils/usePluralForm';
|
|
16
17
|
export { useLocationChange } from './utils/useLocationChange';
|
|
17
18
|
export { usePrevious } from './utils/usePrevious';
|
|
19
|
+
export { useCollapsible, Collapsible } from './components/Collapsible';
|
|
20
|
+
export { default as Details } from './components/Details';
|
|
21
|
+
export { MobileSecondaryMenuProvider, MobileSecondaryMenuFiller, useMobileSecondaryMenuRenderer, } from './utils/mobileSecondaryMenu';
|
|
18
22
|
export { useDocsPreferredVersion, useDocsPreferredVersionByPluginId, } from './utils/docsPreferredVersion/useDocsPreferredVersion';
|
|
23
|
+
export { duplicates, uniq } from './utils/jsUtils';
|
|
19
24
|
export { DocsPreferredVersionContextProvider } from './utils/docsPreferredVersion/DocsPreferredVersionProvider';
|
|
20
25
|
export { ThemeClassNames } from './utils/ThemeClassNames';
|
|
21
26
|
export { AnnouncementBarProvider, useAnnouncementBar, } from './utils/announcementBarUtils';
|
|
27
|
+
export { useLocalPathname } from './utils/useLocalPathname';
|
|
28
|
+
export { translateTagsPageTitle, listTagsByLetters } from './utils/tagsUtils';
|
|
29
|
+
export { useHistoryPopHandler } from './utils/historyUtils';
|
|
30
|
+
export { default as useTOCHighlight } from './utils/useTOCHighlight';
|
|
31
|
+
export { useTOCFilter } from './utils/tocUtils';
|
|
32
|
+
export { ScrollControllerProvider, useScrollController, useScrollPosition, useScrollPositionBlocker, } from './utils/scrollUtils';
|
|
33
|
+
export { useIsomorphicLayoutEffect, useDynamicCallback, } from './utils/reactUtils';
|
|
34
|
+
export { isRegexpStringMatch } from './utils/regexpUtils';
|
|
35
|
+
//# 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,OAAO,EAAC,cAAc,EAAC,MAAM,wBAAwB,CAAC;AAetD,OAAO,EAAC,iBAAiB,EAAE,eAAe,EAAC,MAAM,sBAAsB,CAAC;AAExE,OAAO,EAAC,qBAAqB,EAAC,MAAM,+BAA+B,CAAC;AAEpE,OAAO,EAAC,0BAA0B,EAAC,MAAM,oCAAoC,CAAC;AAE9E,OAAO,EACL,mBAAmB,EACnB,aAAa,EACb,UAAU,GACX,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAC,mBAAmB,EAAE,kBAAkB,EAAC,MAAM,qBAAqB,CAAC;AAE5E,OAAO,EACL,mBAAmB,EACnB,mBAAmB,EACnB,cAAc,EACd,UAAU,EACV,mBAAmB,EACnB,cAAc,EACd,mBAAmB,EACnB,qBAAqB,EACrB,yBAAyB,EACzB,mBAAmB,GACpB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAC,UAAU,EAAC,MAAM,mBAAmB,CAAC;AAE7C,OAAO,EAAC,iBAAiB,EAAC,MAAM,sBAAsB,CAAC;AAEvD,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC;AAEpD,OAAO,EAAC,iBAAiB,EAAC,MAAM,2BAA2B,CAAC;AAE5D,OAAO,EAAC,WAAW,EAAC,MAAM,qBAAqB,CAAC;AAEhD,OAAO,EAAC,cAAc,EAAE,WAAW,EAAC,MAAM,0BAA0B,CAAC;AAMrE,OAAO,EAAC,OAAO,IAAI,OAAO,EAAC,MAAM,sBAAsB,CAAC;AAGxD,OAAO,EACL,2BAA2B,EAC3B,yBAAyB,EACzB,8BAA8B,GAC/B,MAAM,6BAA6B,CAAC;AAGrC,OAAO,EACL,uBAAuB,EACvB,iCAAiC,GAClC,MAAM,sDAAsD,CAAC;AAE9D,OAAO,EAAC,UAAU,EAAE,IAAI,EAAC,MAAM,iBAAiB,CAAC;AAEjD,OAAO,EAAC,mCAAmC,EAAC,MAAM,2DAA2D,CAAC;AAE9G,OAAO,EAAC,eAAe,EAAC,MAAM,yBAAyB,CAAC;AAExD,OAAO,EACL,uBAAuB,EACvB,kBAAkB,GACnB,MAAM,8BAA8B,CAAC;AAEtC,OAAO,EAAC,gBAAgB,EAAC,MAAM,0BAA0B,CAAC;AAE1D,OAAO,EAAC,sBAAsB,EAAE,iBAAiB,EAAC,MAAM,mBAAmB,CAAC;AAG5E,OAAO,EAAC,oBAAoB,EAAC,MAAM,sBAAsB,CAAC;AAE1D,OAAO,EAAC,OAAO,IAAI,eAAe,EAAC,MAAM,yBAAyB,CAAC;AAGnE,OAAO,EAAC,YAAY,EAAC,MAAM,kBAAkB,CAAC;AAE9C,OAAO,EACL,wBAAwB,EACxB,mBAAmB,EACnB,iBAAiB,EACjB,wBAAwB,GACzB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EACL,yBAAyB,EACzB,kBAAkB,GACnB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAC,mBAAmB,EAAC,MAAM,qBAAqB,CAAC"}
|
|
@@ -5,18 +5,44 @@
|
|
|
5
5
|
* LICENSE file in the root directory of this source tree.
|
|
6
6
|
*/
|
|
7
7
|
export declare const ThemeClassNames: {
|
|
8
|
-
page: {
|
|
9
|
-
blogListPage:
|
|
10
|
-
blogPostPage:
|
|
11
|
-
blogTagsListPage:
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
8
|
+
readonly page: {
|
|
9
|
+
readonly blogListPage: "blog-list-page";
|
|
10
|
+
readonly blogPostPage: "blog-post-page";
|
|
11
|
+
readonly blogTagsListPage: "blog-tags-list-page";
|
|
12
|
+
readonly blogTagPostListPage: "blog-tags-post-list-page";
|
|
13
|
+
readonly docsDocPage: "docs-doc-page";
|
|
14
|
+
readonly docsTagsListPage: "docs-tags-list-page";
|
|
15
|
+
readonly docsTagDocListPage: "docs-tags-doc-list-page";
|
|
16
|
+
readonly mdxPage: "mdx-page";
|
|
15
17
|
};
|
|
16
|
-
wrapper: {
|
|
17
|
-
main:
|
|
18
|
-
blogPages:
|
|
19
|
-
|
|
20
|
-
mdxPages:
|
|
18
|
+
readonly wrapper: {
|
|
19
|
+
readonly main: "main-wrapper";
|
|
20
|
+
readonly blogPages: "blog-wrapper";
|
|
21
|
+
readonly docsPages: "docs-wrapper";
|
|
22
|
+
readonly mdxPages: "mdx-wrapper";
|
|
21
23
|
};
|
|
24
|
+
readonly common: {
|
|
25
|
+
readonly editThisPage: "theme-edit-this-page";
|
|
26
|
+
readonly lastUpdated: "theme-last-updated";
|
|
27
|
+
readonly backToTopButton: "theme-back-to-top-button";
|
|
28
|
+
readonly codeBlock: "theme-code-block";
|
|
29
|
+
};
|
|
30
|
+
readonly layout: {};
|
|
31
|
+
readonly docs: {
|
|
32
|
+
readonly docVersionBanner: "theme-doc-version-banner";
|
|
33
|
+
readonly docVersionBadge: "theme-doc-version-badge";
|
|
34
|
+
readonly docMarkdown: "theme-doc-markdown";
|
|
35
|
+
readonly docTocMobile: "theme-doc-toc-mobile";
|
|
36
|
+
readonly docTocDesktop: "theme-doc-toc-desktop";
|
|
37
|
+
readonly docFooter: "theme-doc-footer";
|
|
38
|
+
readonly docFooterTagsRow: "theme-doc-footer-tags-row";
|
|
39
|
+
readonly docFooterEditMetaRow: "theme-doc-footer-edit-meta-row";
|
|
40
|
+
readonly docSidebarMenu: "theme-doc-sidebar-menu";
|
|
41
|
+
readonly docSidebarItemCategory: "theme-doc-sidebar-item-category";
|
|
42
|
+
readonly docSidebarItemLink: "theme-doc-sidebar-item-link";
|
|
43
|
+
readonly docSidebarItemCategoryLevel: (level: number) => `theme-doc-sidebar-item-category-level-${number}`;
|
|
44
|
+
readonly docSidebarItemLinkLevel: (level: number) => `theme-doc-sidebar-item-link-level-${number}`;
|
|
45
|
+
};
|
|
46
|
+
readonly blog: {};
|
|
22
47
|
};
|
|
48
|
+
//# sourceMappingURL=ThemeClassNames.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ThemeClassNames.d.ts","sourceRoot":"","sources":["../../src/utils/ThemeClassNames.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAKH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sDA2Ca,MAAM;kDAEV,MAAM;;;CAOjC,CAAC"}
|
|
@@ -5,19 +5,54 @@
|
|
|
5
5
|
* LICENSE file in the root directory of this source tree.
|
|
6
6
|
*/
|
|
7
7
|
// These class names are used to style page layouts in Docusaurus
|
|
8
|
+
// Those are meant to be targeted by user-provided custom CSS selectors
|
|
9
|
+
// /!\ Please do not modify the classnames! This is a breaking change, and annoying for users!
|
|
8
10
|
export const ThemeClassNames = {
|
|
9
11
|
page: {
|
|
10
12
|
blogListPage: 'blog-list-page',
|
|
11
13
|
blogPostPage: 'blog-post-page',
|
|
12
14
|
blogTagsListPage: 'blog-tags-list-page',
|
|
13
|
-
|
|
14
|
-
|
|
15
|
+
blogTagPostListPage: 'blog-tags-post-list-page',
|
|
16
|
+
docsDocPage: 'docs-doc-page',
|
|
17
|
+
docsTagsListPage: 'docs-tags-list-page',
|
|
18
|
+
docsTagDocListPage: 'docs-tags-doc-list-page',
|
|
15
19
|
mdxPage: 'mdx-page',
|
|
16
20
|
},
|
|
17
21
|
wrapper: {
|
|
18
22
|
main: 'main-wrapper',
|
|
19
23
|
blogPages: 'blog-wrapper',
|
|
20
|
-
|
|
24
|
+
docsPages: 'docs-wrapper',
|
|
21
25
|
mdxPages: 'mdx-wrapper',
|
|
22
26
|
},
|
|
27
|
+
// /!\ Please keep the naming convention consistent!
|
|
28
|
+
// Something like: "theme-{blog,doc,version,page}?-<suffix>"
|
|
29
|
+
common: {
|
|
30
|
+
editThisPage: 'theme-edit-this-page',
|
|
31
|
+
lastUpdated: 'theme-last-updated',
|
|
32
|
+
backToTopButton: 'theme-back-to-top-button',
|
|
33
|
+
codeBlock: 'theme-code-block',
|
|
34
|
+
},
|
|
35
|
+
layout: {
|
|
36
|
+
// TODO add other stable classNames here
|
|
37
|
+
},
|
|
38
|
+
docs: {
|
|
39
|
+
docVersionBanner: 'theme-doc-version-banner',
|
|
40
|
+
docVersionBadge: 'theme-doc-version-badge',
|
|
41
|
+
docMarkdown: 'theme-doc-markdown',
|
|
42
|
+
docTocMobile: 'theme-doc-toc-mobile',
|
|
43
|
+
docTocDesktop: 'theme-doc-toc-desktop',
|
|
44
|
+
docFooter: 'theme-doc-footer',
|
|
45
|
+
docFooterTagsRow: 'theme-doc-footer-tags-row',
|
|
46
|
+
docFooterEditMetaRow: 'theme-doc-footer-edit-meta-row',
|
|
47
|
+
docSidebarMenu: 'theme-doc-sidebar-menu',
|
|
48
|
+
docSidebarItemCategory: 'theme-doc-sidebar-item-category',
|
|
49
|
+
docSidebarItemLink: 'theme-doc-sidebar-item-link',
|
|
50
|
+
docSidebarItemCategoryLevel: (level) => `theme-doc-sidebar-item-category-level-${level}`,
|
|
51
|
+
docSidebarItemLinkLevel: (level) => `theme-doc-sidebar-item-link-level-${level}`,
|
|
52
|
+
// TODO add other stable classNames here
|
|
53
|
+
},
|
|
54
|
+
blog: {
|
|
55
|
+
// TODO add other stable classNames here
|
|
56
|
+
},
|
|
23
57
|
};
|
|
58
|
+
//# sourceMappingURL=ThemeClassNames.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ThemeClassNames.js","sourceRoot":"","sources":["../../src/utils/ThemeClassNames.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,iEAAiE;AACjE,uEAAuE;AACvE,8FAA8F;AAC9F,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,IAAI,EAAE;QACJ,YAAY,EAAE,gBAAgB;QAC9B,YAAY,EAAE,gBAAgB;QAC9B,gBAAgB,EAAE,qBAAqB;QACvC,mBAAmB,EAAE,0BAA0B;QAE/C,WAAW,EAAE,eAAe;QAC5B,gBAAgB,EAAE,qBAAqB;QACvC,kBAAkB,EAAE,yBAAyB;QAE7C,OAAO,EAAE,UAAU;KACpB;IACD,OAAO,EAAE;QACP,IAAI,EAAE,cAAc;QACpB,SAAS,EAAE,cAAc;QACzB,SAAS,EAAE,cAAc;QACzB,QAAQ,EAAE,aAAa;KACxB;IAED,oDAAoD;IACpD,4DAA4D;IAC5D,MAAM,EAAE;QACN,YAAY,EAAE,sBAAsB;QACpC,WAAW,EAAE,oBAAoB;QACjC,eAAe,EAAE,0BAA0B;QAC3C,SAAS,EAAE,kBAAkB;KAC9B;IACD,MAAM,EAAE;IACN,wCAAwC;KACzC;IACD,IAAI,EAAE;QACJ,gBAAgB,EAAE,0BAA0B;QAC5C,eAAe,EAAE,yBAAyB;QAC1C,WAAW,EAAE,oBAAoB;QACjC,YAAY,EAAE,sBAAsB;QACpC,aAAa,EAAE,uBAAuB;QACtC,SAAS,EAAE,kBAAkB;QAC7B,gBAAgB,EAAE,2BAA2B;QAC7C,oBAAoB,EAAE,gCAAgC;QACtD,cAAc,EAAE,wBAAwB;QACxC,sBAAsB,EAAE,iCAAiC;QACzD,kBAAkB,EAAE,6BAA6B;QACjD,2BAA2B,EAAE,CAAC,KAAa,EAAE,EAAE,CAC7C,yCAAyC,KAAK,EAAW;QAC3D,uBAAuB,EAAE,CAAC,KAAa,EAAE,EAAE,CACzC,qCAAqC,KAAK,EAAW;QACvD,wCAAwC;KACzC;IACD,IAAI,EAAE;IACJ,wCAAwC;KACzC;CACO,CAAC"}
|
|
@@ -7,11 +7,12 @@
|
|
|
7
7
|
import { ReactNode } from 'react';
|
|
8
8
|
export declare const AnnouncementBarDismissStorageKey = "docusaurus.announcement.dismiss";
|
|
9
9
|
declare type AnnouncementBarAPI = {
|
|
10
|
-
readonly
|
|
10
|
+
readonly isActive: boolean;
|
|
11
11
|
readonly close: () => void;
|
|
12
12
|
};
|
|
13
|
-
export declare
|
|
13
|
+
export declare function AnnouncementBarProvider({ children, }: {
|
|
14
14
|
children: ReactNode;
|
|
15
|
-
})
|
|
15
|
+
}): JSX.Element;
|
|
16
16
|
export declare const useAnnouncementBar: () => AnnouncementBarAPI;
|
|
17
17
|
export {};
|
|
18
|
+
//# sourceMappingURL=announcementBarUtils.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"announcementBarUtils.d.ts","sourceRoot":"","sources":["../../src/utils/announcementBarUtils.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAc,EAKZ,SAAS,EAGV,MAAM,OAAO,CAAC;AAKf,eAAO,MAAM,gCAAgC,oCACV,CAAC;AAapC,aAAK,kBAAkB,GAAG;IACxB,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,KAAK,EAAE,MAAM,IAAI,CAAC;CAC5B,CAAC;AA6DF,wBAAgB,uBAAuB,CAAC,EACtC,QAAQ,GACT,EAAE;IACD,QAAQ,EAAE,SAAS,CAAC;CACrB,GAAG,GAAG,CAAC,OAAO,CAOd;AAED,eAAO,MAAM,kBAAkB,QAAO,kBAQrC,CAAC"}
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* LICENSE file in the root directory of this source tree.
|
|
6
6
|
*/
|
|
7
7
|
import React, { useState, useEffect, useCallback, useMemo, useContext, createContext, } from 'react';
|
|
8
|
-
import
|
|
8
|
+
import useIsBrowser from '@docusaurus/useIsBrowser';
|
|
9
9
|
import { createStorageSlot } from './storageUtils';
|
|
10
10
|
import { useThemeConfig } from './useThemeConfig';
|
|
11
11
|
export const AnnouncementBarDismissStorageKey = 'docusaurus.announcement.dismiss';
|
|
@@ -16,14 +16,12 @@ const isDismissedInStorage = () => AnnouncementBarDismissStorage.get() === 'true
|
|
|
16
16
|
const setDismissedInStorage = (bool) => AnnouncementBarDismissStorage.set(String(bool));
|
|
17
17
|
const useAnnouncementBarContextValue = () => {
|
|
18
18
|
const { announcementBar } = useThemeConfig();
|
|
19
|
-
const
|
|
20
|
-
const [isClosed, setClosed] = useState(() =>
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
false;
|
|
26
|
-
});
|
|
19
|
+
const isBrowser = useIsBrowser();
|
|
20
|
+
const [isClosed, setClosed] = useState(() => isBrowser
|
|
21
|
+
? // On client navigation: init with localstorage value
|
|
22
|
+
isDismissedInStorage()
|
|
23
|
+
: // On server/hydration: always visible to prevent layout shifts (will be hidden with css if needed)
|
|
24
|
+
false);
|
|
27
25
|
// Update state after hydration
|
|
28
26
|
useEffect(() => {
|
|
29
27
|
setClosed(isDismissedInStorage());
|
|
@@ -51,19 +49,17 @@ const useAnnouncementBarContextValue = () => {
|
|
|
51
49
|
if (isNewAnnouncement || !isDismissedInStorage()) {
|
|
52
50
|
setClosed(false);
|
|
53
51
|
}
|
|
54
|
-
}, []);
|
|
55
|
-
return useMemo(() => {
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
};
|
|
60
|
-
}, [isClosed]);
|
|
52
|
+
}, [announcementBar]);
|
|
53
|
+
return useMemo(() => ({
|
|
54
|
+
isActive: !!announcementBar && !isClosed,
|
|
55
|
+
close: handleClose,
|
|
56
|
+
}), [announcementBar, isClosed, handleClose]);
|
|
61
57
|
};
|
|
62
58
|
const AnnouncementBarContext = createContext(null);
|
|
63
|
-
export
|
|
59
|
+
export function AnnouncementBarProvider({ children, }) {
|
|
64
60
|
const value = useAnnouncementBarContextValue();
|
|
65
61
|
return (React.createElement(AnnouncementBarContext.Provider, { value: value }, children));
|
|
66
|
-
}
|
|
62
|
+
}
|
|
67
63
|
export const useAnnouncementBar = () => {
|
|
68
64
|
const api = useContext(AnnouncementBarContext);
|
|
69
65
|
if (!api) {
|
|
@@ -71,3 +67,4 @@ export const useAnnouncementBar = () => {
|
|
|
71
67
|
}
|
|
72
68
|
return api;
|
|
73
69
|
};
|
|
70
|
+
//# sourceMappingURL=announcementBarUtils.js.map
|