@fumadocs/ui 16.4.1 → 16.4.3
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/css/colors/ocean.css +1 -5
- package/css/colors/vitepress.css +3 -15
- package/dist/cn.d.ts +2 -2
- package/dist/cn.js +3 -1
- package/dist/components/toc/clerk.d.ts +11 -2
- package/dist/components/toc/clerk.d.ts.map +1 -1
- package/dist/components/toc/clerk.js +105 -69
- package/dist/components/toc/clerk.js.map +1 -0
- package/dist/components/toc/default.d.ts +11 -2
- package/dist/components/toc/default.d.ts.map +1 -1
- package/dist/components/toc/default.js +36 -15
- package/dist/components/toc/default.js.map +1 -0
- package/dist/components/toc/index.d.ts +23 -8
- package/dist/components/toc/index.d.ts.map +1 -1
- package/dist/components/toc/index.js +74 -59
- package/dist/components/toc/index.js.map +1 -0
- package/dist/contexts/i18n.d.ts +53 -43
- package/dist/contexts/i18n.d.ts.map +1 -1
- package/dist/contexts/i18n.js +55 -50
- package/dist/contexts/i18n.js.map +1 -0
- package/dist/contexts/search.d.ts +62 -49
- package/dist/contexts/search.d.ts.map +1 -1
- package/dist/contexts/search.js +56 -50
- package/dist/contexts/search.js.map +1 -0
- package/dist/contexts/tree.d.ts +18 -11
- package/dist/contexts/tree.d.ts.map +1 -1
- package/dist/contexts/tree.js +36 -26
- package/dist/contexts/tree.js.map +1 -0
- package/dist/hooks/use-copy-button.d.ts +6 -2
- package/dist/hooks/use-copy-button.d.ts.map +1 -1
- package/dist/hooks/use-copy-button.js +28 -25
- package/dist/hooks/use-copy-button.js.map +1 -0
- package/dist/hooks/use-footer-items.d.ts +7 -2
- package/dist/hooks/use-footer-items.d.ts.map +1 -1
- package/dist/hooks/use-footer-items.js +26 -25
- package/dist/hooks/use-footer-items.js.map +1 -0
- package/dist/hooks/use-is-scroll-top.d.ts +7 -2
- package/dist/hooks/use-is-scroll-top.d.ts.map +1 -1
- package/dist/hooks/use-is-scroll-top.js +23 -16
- package/dist/hooks/use-is-scroll-top.js.map +1 -0
- package/dist/i18n.d.ts +11 -11
- package/dist/i18n.d.ts.map +1 -1
- package/dist/i18n.js +19 -15
- package/dist/i18n.js.map +1 -0
- package/dist/link-item.d.ts +74 -66
- package/dist/link-item.d.ts.map +1 -1
- package/dist/link-item.js +23 -10
- package/dist/link-item.js.map +1 -0
- package/dist/merge-refs.d.ts +6 -2
- package/dist/merge-refs.d.ts.map +1 -1
- package/dist/merge-refs.js +12 -11
- package/dist/merge-refs.js.map +1 -0
- package/dist/og/next.d.ts +20 -12
- package/dist/og/next.d.ts.map +1 -1
- package/dist/og/next.js +68 -43
- package/dist/og/next.js.map +1 -0
- package/dist/typography/index.d.ts +10 -8
- package/dist/typography/index.d.ts.map +1 -1
- package/dist/typography/index.js +1714 -127
- package/dist/typography/index.js.map +1 -0
- package/dist/typography/styles.d.ts +92 -89
- package/dist/typography/styles.d.ts.map +1 -1
- package/dist/typography/styles.js +337 -423
- package/dist/typography/styles.js.map +1 -0
- package/dist/urls.d.ts +5 -2
- package/dist/urls.d.ts.map +1 -1
- package/dist/urls.js +14 -10
- package/dist/urls.js.map +1 -0
- package/package.json +20 -20
- package/dist/cn.d.ts.map +0 -1
- package/dist/icons.d.ts +0 -50
- package/dist/icons.d.ts.map +0 -1
- package/dist/icons.js +0 -292
package/dist/contexts/i18n.d.ts
CHANGED
|
@@ -1,50 +1,60 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
1
|
+
import { ReactNode } from "react";
|
|
2
|
+
import * as react_jsx_runtime0 from "react/jsx-runtime";
|
|
3
|
+
|
|
4
|
+
//#region src/contexts/i18n.d.ts
|
|
5
|
+
interface Translations {
|
|
6
|
+
search: string;
|
|
7
|
+
searchNoResult: string;
|
|
8
|
+
toc: string;
|
|
9
|
+
tocNoHeadings: string;
|
|
10
|
+
lastUpdate: string;
|
|
11
|
+
chooseLanguage: string;
|
|
12
|
+
nextPage: string;
|
|
13
|
+
previousPage: string;
|
|
14
|
+
chooseTheme: string;
|
|
15
|
+
editOnGithub: string;
|
|
13
16
|
}
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
+
interface LocaleItem {
|
|
18
|
+
name: string;
|
|
19
|
+
locale: string;
|
|
17
20
|
}
|
|
18
21
|
interface I18nContextType {
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
22
|
+
locale?: string;
|
|
23
|
+
onChange?: (v: string) => void;
|
|
24
|
+
text: Translations;
|
|
25
|
+
locales?: LocaleItem[];
|
|
23
26
|
}
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
+
declare const defaultTranslations: Translations;
|
|
28
|
+
declare function I18nLabel(props: {
|
|
29
|
+
label: keyof Translations;
|
|
27
30
|
}): string;
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
31
|
+
declare function useI18n(): I18nContextType;
|
|
32
|
+
interface I18nProviderProps {
|
|
33
|
+
/**
|
|
34
|
+
* Current locale
|
|
35
|
+
*/
|
|
36
|
+
locale: string;
|
|
37
|
+
/**
|
|
38
|
+
* Handle changes to the locale, redirect user when not specified.
|
|
39
|
+
*/
|
|
40
|
+
onLocaleChange?: (v: string) => void;
|
|
41
|
+
/**
|
|
42
|
+
* Translations of current locale
|
|
43
|
+
*/
|
|
44
|
+
translations?: Partial<Translations>;
|
|
45
|
+
/**
|
|
46
|
+
* Available languages
|
|
47
|
+
*/
|
|
48
|
+
locales?: LocaleItem[];
|
|
49
|
+
children?: ReactNode;
|
|
47
50
|
}
|
|
48
|
-
|
|
49
|
-
|
|
51
|
+
declare function I18nProvider({
|
|
52
|
+
locales,
|
|
53
|
+
locale,
|
|
54
|
+
onLocaleChange,
|
|
55
|
+
children,
|
|
56
|
+
translations
|
|
57
|
+
}: I18nProviderProps): react_jsx_runtime0.JSX.Element;
|
|
58
|
+
//#endregion
|
|
59
|
+
export { I18nLabel, I18nProvider, I18nProviderProps, LocaleItem, Translations, defaultTranslations, useI18n };
|
|
50
60
|
//# sourceMappingURL=i18n.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"i18n.d.ts","
|
|
1
|
+
{"version":3,"file":"i18n.d.ts","names":[],"sources":["../../src/contexts/i18n.tsx"],"sourcesContent":[],"mappings":";;;;UAIiB,YAAA;;;EAAA,GAAA,EAAA,MAAA;EAeA,aAAU,EAAA,MAAA;EAKjB,UAAA,EAAA,MAAe;EAOZ,cAAA,EAAA,MAWZ;EAMe,QAAA,EAAA,MAAS;EAMT,YAAO,EAAA,MAAA;EAIN,WAAA,EAAA,MAAA;EAcQ,YAAA,EAAA,MAAA;;AAKb,UA1DK,UAAA,CA0DL;EAEC,IAAA,EAAA,MAAA;EAAS,MAAA,EAAA,MAAA;AAGtB;UA1DU,eAAA,CA2DR;EACA,MAAA,CAAA,EAAA,MAAA;EACA,QAAA,CAAA,EAAA,CAAA,CAAA,EAAA,MAAA,EAAA,GAAA,IAAA;EACA,IAAA,EA3DM,YA2DN;EACA,OAAA,CAAA,EA3DU,UA2DV,EAAA;;AACkB,cAzDP,mBAyDO,EAzDc,YAyDd;AAAA,iBAxCJ,SAAA,CAwCI,KAAA,EAAA;eAxC4B;;iBAMhC,OAAA,CAAA,GAAW;UAIV,iBAAA;;;;;;;;;;;;iBAcA,QAAQ;;;;YAKb;aAEC;;iBAGG,YAAA;;;;;;GAMb,oBAAiB,kBAAA,CAAA,GAAA,CAAA"}
|
package/dist/contexts/i18n.js
CHANGED
|
@@ -1,55 +1,60 @@
|
|
|
1
1
|
'use client';
|
|
2
|
-
|
|
3
|
-
import { createContext, useContext, useMemo, useRef
|
|
4
|
-
import { usePathname, useRouter } from
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
2
|
+
|
|
3
|
+
import { createContext, useContext, useMemo, useRef } from "react";
|
|
4
|
+
import { usePathname, useRouter } from "fumadocs-core/framework";
|
|
5
|
+
import { jsx } from "react/jsx-runtime";
|
|
6
|
+
|
|
7
|
+
//#region src/contexts/i18n.tsx
|
|
8
|
+
const defaultTranslations = {
|
|
9
|
+
search: "Search",
|
|
10
|
+
searchNoResult: "No results found",
|
|
11
|
+
toc: "On this page",
|
|
12
|
+
tocNoHeadings: "No Headings",
|
|
13
|
+
lastUpdate: "Last updated on",
|
|
14
|
+
chooseLanguage: "Choose a language",
|
|
15
|
+
nextPage: "Next Page",
|
|
16
|
+
previousPage: "Previous Page",
|
|
17
|
+
chooseTheme: "Theme",
|
|
18
|
+
editOnGithub: "Edit on GitHub"
|
|
16
19
|
};
|
|
17
|
-
const I18nContext = createContext({
|
|
18
|
-
|
|
19
|
-
});
|
|
20
|
-
|
|
21
|
-
const { text } = useI18n();
|
|
22
|
-
return text[props.label];
|
|
20
|
+
const I18nContext = createContext({ text: defaultTranslations });
|
|
21
|
+
function I18nLabel(props) {
|
|
22
|
+
const { text } = useI18n();
|
|
23
|
+
return text[props.label];
|
|
23
24
|
}
|
|
24
|
-
|
|
25
|
-
|
|
25
|
+
function useI18n() {
|
|
26
|
+
return useContext(I18nContext);
|
|
26
27
|
}
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
28
|
+
function I18nProvider({ locales = [], locale, onLocaleChange, children, translations }) {
|
|
29
|
+
const router = useRouter();
|
|
30
|
+
const pathname = usePathname();
|
|
31
|
+
const onChange = (value) => {
|
|
32
|
+
if (onLocaleChange) return onLocaleChange(value);
|
|
33
|
+
const segments = pathname.split("/").filter((v) => v.length > 0);
|
|
34
|
+
if (segments[0] !== locale) segments.unshift(value);
|
|
35
|
+
else segments[0] = value;
|
|
36
|
+
router.push(`/${segments.join("/")}`);
|
|
37
|
+
};
|
|
38
|
+
const onChangeRef = useRef(onChange);
|
|
39
|
+
onChangeRef.current = onChange;
|
|
40
|
+
return /* @__PURE__ */ jsx(I18nContext, {
|
|
41
|
+
value: useMemo(() => ({
|
|
42
|
+
locale,
|
|
43
|
+
locales,
|
|
44
|
+
text: {
|
|
45
|
+
...defaultTranslations,
|
|
46
|
+
...translations
|
|
47
|
+
},
|
|
48
|
+
onChange: (v) => onChangeRef.current(v)
|
|
49
|
+
}), [
|
|
50
|
+
locale,
|
|
51
|
+
locales,
|
|
52
|
+
translations
|
|
53
|
+
]),
|
|
54
|
+
children
|
|
55
|
+
});
|
|
55
56
|
}
|
|
57
|
+
|
|
58
|
+
//#endregion
|
|
59
|
+
export { I18nLabel, I18nProvider, defaultTranslations, useI18n };
|
|
60
|
+
//# sourceMappingURL=i18n.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"i18n.js","names":["defaultTranslations: Translations"],"sources":["../../src/contexts/i18n.tsx"],"sourcesContent":["'use client';\nimport { createContext, type ReactNode, useContext, useMemo, useRef } from 'react';\nimport { usePathname, useRouter } from 'fumadocs-core/framework';\n\nexport interface Translations {\n search: string;\n searchNoResult: string;\n\n toc: string;\n tocNoHeadings: string;\n\n lastUpdate: string;\n chooseLanguage: string;\n nextPage: string;\n previousPage: string;\n chooseTheme: string;\n editOnGithub: string;\n}\n\nexport interface LocaleItem {\n name: string;\n locale: string;\n}\n\ninterface I18nContextType {\n locale?: string;\n onChange?: (v: string) => void;\n text: Translations;\n locales?: LocaleItem[];\n}\n\nexport const defaultTranslations: Translations = {\n search: 'Search',\n searchNoResult: 'No results found',\n toc: 'On this page',\n tocNoHeadings: 'No Headings',\n lastUpdate: 'Last updated on',\n chooseLanguage: 'Choose a language',\n nextPage: 'Next Page',\n previousPage: 'Previous Page',\n chooseTheme: 'Theme',\n editOnGithub: 'Edit on GitHub',\n};\n\nconst I18nContext = createContext<I18nContextType>({\n text: defaultTranslations,\n});\n\nexport function I18nLabel(props: { label: keyof Translations }): string {\n const { text } = useI18n();\n\n return text[props.label];\n}\n\nexport function useI18n(): I18nContextType {\n return useContext(I18nContext);\n}\n\nexport interface I18nProviderProps {\n /**\n * Current locale\n */\n locale: string;\n\n /**\n * Handle changes to the locale, redirect user when not specified.\n */\n onLocaleChange?: (v: string) => void;\n\n /**\n * Translations of current locale\n */\n translations?: Partial<Translations>;\n\n /**\n * Available languages\n */\n locales?: LocaleItem[];\n\n children?: ReactNode;\n}\n\nexport function I18nProvider({\n locales = [],\n locale,\n onLocaleChange,\n children,\n translations,\n}: I18nProviderProps) {\n const router = useRouter();\n const pathname = usePathname();\n const onChange = (value: string) => {\n if (onLocaleChange) {\n return onLocaleChange(value);\n }\n const segments = pathname.split('/').filter((v) => v.length > 0);\n\n // If locale prefix hidden\n if (segments[0] !== locale) {\n segments.unshift(value);\n } else {\n segments[0] = value;\n }\n\n router.push(`/${segments.join('/')}`);\n };\n const onChangeRef = useRef(onChange);\n onChangeRef.current = onChange;\n\n return (\n <I18nContext\n value={useMemo(\n () => ({\n locale,\n locales,\n text: {\n ...defaultTranslations,\n ...translations,\n },\n onChange: (v) => onChangeRef.current(v),\n }),\n [locale, locales, translations],\n )}\n >\n {children}\n </I18nContext>\n );\n}\n"],"mappings":";;;;;;;AA+BA,MAAaA,sBAAoC;CAC/C,QAAQ;CACR,gBAAgB;CAChB,KAAK;CACL,eAAe;CACf,YAAY;CACZ,gBAAgB;CAChB,UAAU;CACV,cAAc;CACd,aAAa;CACb,cAAc;CACf;AAED,MAAM,cAAc,cAA+B,EACjD,MAAM,qBACP,CAAC;AAEF,SAAgB,UAAU,OAA8C;CACtE,MAAM,EAAE,SAAS,SAAS;AAE1B,QAAO,KAAK,MAAM;;AAGpB,SAAgB,UAA2B;AACzC,QAAO,WAAW,YAAY;;AA2BhC,SAAgB,aAAa,EAC3B,UAAU,EAAE,EACZ,QACA,gBACA,UACA,gBACoB;CACpB,MAAM,SAAS,WAAW;CAC1B,MAAM,WAAW,aAAa;CAC9B,MAAM,YAAY,UAAkB;AAClC,MAAI,eACF,QAAO,eAAe,MAAM;EAE9B,MAAM,WAAW,SAAS,MAAM,IAAI,CAAC,QAAQ,MAAM,EAAE,SAAS,EAAE;AAGhE,MAAI,SAAS,OAAO,OAClB,UAAS,QAAQ,MAAM;MAEvB,UAAS,KAAK;AAGhB,SAAO,KAAK,IAAI,SAAS,KAAK,IAAI,GAAG;;CAEvC,MAAM,cAAc,OAAO,SAAS;AACpC,aAAY,UAAU;AAEtB,QACE,oBAAC;EACC,OAAO,eACE;GACL;GACA;GACA,MAAM;IACJ,GAAG;IACH,GAAG;IACJ;GACD,WAAW,MAAM,YAAY,QAAQ,EAAE;GACxC,GACD;GAAC;GAAQ;GAAS;GAAa,CAChC;EAEA;GACW"}
|
|
@@ -1,61 +1,74 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { ComponentType, ReactNode } from "react";
|
|
2
|
+
import * as react_jsx_runtime1 from "react/jsx-runtime";
|
|
3
|
+
|
|
4
|
+
//#region src/contexts/search.d.ts
|
|
2
5
|
interface HotKey {
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
6
|
+
display: ReactNode;
|
|
7
|
+
/**
|
|
8
|
+
* Key code or a function determining whether the key is pressed.
|
|
9
|
+
*/
|
|
10
|
+
key: string | ((e: KeyboardEvent) => boolean);
|
|
8
11
|
}
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
+
interface SharedProps {
|
|
13
|
+
open: boolean;
|
|
14
|
+
onOpenChange: (open: boolean) => void;
|
|
12
15
|
}
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
16
|
+
type SearchLink = [name: string, href: string];
|
|
17
|
+
interface TagItem {
|
|
18
|
+
name: string;
|
|
19
|
+
value: string;
|
|
17
20
|
}
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
21
|
+
interface SearchProviderProps {
|
|
22
|
+
/**
|
|
23
|
+
* Preload search dialog before opening it
|
|
24
|
+
*
|
|
25
|
+
* @defaultValue `true`
|
|
26
|
+
*/
|
|
27
|
+
preload?: boolean;
|
|
28
|
+
/**
|
|
29
|
+
* Custom links to be displayed if search is empty
|
|
30
|
+
*/
|
|
31
|
+
links?: SearchLink[];
|
|
32
|
+
/**
|
|
33
|
+
* Hotkeys for triggering search dialog
|
|
34
|
+
*
|
|
35
|
+
* @defaultValue Meta/Ctrl + K
|
|
36
|
+
*/
|
|
37
|
+
hotKey?: HotKey[];
|
|
38
|
+
/**
|
|
39
|
+
* Replace default search dialog, allowing you to use other solutions such as Algolia Search
|
|
40
|
+
*
|
|
41
|
+
* It receives the `open` and `onOpenChange` prop, can be lazy loaded with `next/dynamic`
|
|
42
|
+
*/
|
|
43
|
+
SearchDialog: ComponentType<SharedProps>;
|
|
44
|
+
/**
|
|
45
|
+
* Additional props to the dialog
|
|
46
|
+
*/
|
|
47
|
+
options?: Partial<SharedProps & Record<string, unknown>>;
|
|
48
|
+
children?: ReactNode;
|
|
46
49
|
}
|
|
47
50
|
interface SearchContextType {
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
+
enabled: boolean;
|
|
52
|
+
hotKey: HotKey[];
|
|
53
|
+
setOpenSearch: (value: boolean) => void;
|
|
51
54
|
}
|
|
52
|
-
|
|
53
|
-
|
|
55
|
+
declare function useSearchContext(): SearchContextType;
|
|
56
|
+
declare function SearchProvider({
|
|
57
|
+
SearchDialog,
|
|
58
|
+
children,
|
|
59
|
+
preload,
|
|
60
|
+
options,
|
|
61
|
+
hotKey,
|
|
62
|
+
links
|
|
63
|
+
}: SearchProviderProps): react_jsx_runtime1.JSX.Element;
|
|
54
64
|
/**
|
|
55
65
|
* Show children only when search is enabled via React Context
|
|
56
66
|
*/
|
|
57
|
-
|
|
58
|
-
|
|
67
|
+
declare function SearchOnly({
|
|
68
|
+
children
|
|
69
|
+
}: {
|
|
70
|
+
children: ReactNode;
|
|
59
71
|
}): ReactNode;
|
|
60
|
-
|
|
72
|
+
//#endregion
|
|
73
|
+
export { SearchLink, SearchOnly, SearchProvider, SearchProviderProps, SharedProps, TagItem, useSearchContext };
|
|
61
74
|
//# sourceMappingURL=search.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"search.d.ts","
|
|
1
|
+
{"version":3,"file":"search.d.ts","names":[],"sources":["../../src/contexts/search.tsx"],"sourcesContent":[],"mappings":";;;;UAYU,MAAA;WACC;;AAHI;AAWf;EAKY,GAAA,EAAA,MAAA,GAAU,CAAA,CAAA,CAAA,EARD,aAQC,EAAA,GAAA,OAAA,CAAA;AAEtB;AAKiB,UAZA,WAAA,CAYmB;EAW1B,IAAA,EAAA,OAAA;EAOC,YAAA,EAAA,CAAA,IAAA,EAAA,OAAA,EAAA,GAAA,IAAA;;AAOK,KAhCJ,UAAA,GAgCI,CAAA,IAAA,EAAA,MAAA,EAAA,IAAA,EAAA,MAAA,CAAA;AAKI,UAnCH,OAAA,CAmCG;EAAc,IAAA,EAAA,MAAA;EAAtB,KAAA,EAAA,MAAA;;AAEU,UAhCL,mBAAA,CAgCK;EAGZ;AAYV;AAgBA;;;EAGE,OAAA,CAAA,EAAA,OAAA;EACA;;;EAYC,KAAA,CAAA,EApEO,UAoEP,EAAA;EAAmB;;AA4CtB;;;EAAgE,MAAA,CAAA,EAzGrD,MAyGqD,EAAA;EAAA;;;;;gBAlGhD,cAAc;;;;YAKlB,QAAQ,cAAc;aAErB;;UAGH,iBAAA;;UAEA;;;iBAUM,gBAAA,CAAA,GAAoB;iBAgBpB,cAAA;;;;;;;GAgBb,sBAAmB,kBAAA,CAAA,GAAA,CAAA;;;;iBA4CN,UAAA;;;YAAqC;IAAW"}
|
package/dist/contexts/search.js
CHANGED
|
@@ -1,59 +1,65 @@
|
|
|
1
1
|
'use client';
|
|
2
|
-
|
|
3
|
-
import { createContext, use, useEffect, useEffectEvent, useMemo, useState
|
|
2
|
+
|
|
3
|
+
import { createContext, use, useEffect, useEffectEvent, useMemo, useState } from "react";
|
|
4
|
+
import { jsx, jsxs } from "react/jsx-runtime";
|
|
5
|
+
|
|
6
|
+
//#region src/contexts/search.tsx
|
|
4
7
|
const SearchContext = createContext({
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
+
enabled: false,
|
|
9
|
+
hotKey: [],
|
|
10
|
+
setOpenSearch: () => void 0
|
|
8
11
|
});
|
|
9
|
-
|
|
10
|
-
|
|
12
|
+
function useSearchContext() {
|
|
13
|
+
return use(SearchContext);
|
|
11
14
|
}
|
|
12
15
|
function MetaOrControl() {
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
}, []);
|
|
19
|
-
return key;
|
|
16
|
+
const [key, setKey] = useState("⌘");
|
|
17
|
+
useEffect(() => {
|
|
18
|
+
if (window.navigator.userAgent.includes("Windows")) setKey("Ctrl");
|
|
19
|
+
}, []);
|
|
20
|
+
return key;
|
|
20
21
|
}
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
22
|
+
function SearchProvider({ SearchDialog, children, preload = true, options, hotKey = [{
|
|
23
|
+
key: (e) => e.metaKey || e.ctrlKey,
|
|
24
|
+
display: /* @__PURE__ */ jsx(MetaOrControl, {})
|
|
25
|
+
}, {
|
|
26
|
+
key: "k",
|
|
27
|
+
display: "K"
|
|
28
|
+
}], links }) {
|
|
29
|
+
const [isOpen, setIsOpen] = useState(preload ? false : void 0);
|
|
30
|
+
const onKeyDown = useEffectEvent((e) => {
|
|
31
|
+
if (hotKey.every((v) => typeof v.key === "string" ? e.key === v.key : v.key(e))) {
|
|
32
|
+
setIsOpen((open) => !open);
|
|
33
|
+
e.preventDefault();
|
|
34
|
+
}
|
|
35
|
+
});
|
|
36
|
+
useEffect(() => {
|
|
37
|
+
window.addEventListener("keydown", onKeyDown);
|
|
38
|
+
return () => {
|
|
39
|
+
window.removeEventListener("keydown", onKeyDown);
|
|
40
|
+
};
|
|
41
|
+
}, [hotKey]);
|
|
42
|
+
return /* @__PURE__ */ jsxs(SearchContext, {
|
|
43
|
+
value: useMemo(() => ({
|
|
44
|
+
enabled: true,
|
|
45
|
+
hotKey,
|
|
46
|
+
setOpenSearch: setIsOpen
|
|
47
|
+
}), [hotKey]),
|
|
48
|
+
children: [isOpen !== void 0 && /* @__PURE__ */ jsx(SearchDialog, {
|
|
49
|
+
open: isOpen,
|
|
50
|
+
onOpenChange: setIsOpen,
|
|
51
|
+
links,
|
|
52
|
+
...options
|
|
53
|
+
}), children]
|
|
54
|
+
});
|
|
51
55
|
}
|
|
52
56
|
/**
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
if (search.enabled)
|
|
58
|
-
return children;
|
|
57
|
+
* Show children only when search is enabled via React Context
|
|
58
|
+
*/
|
|
59
|
+
function SearchOnly({ children }) {
|
|
60
|
+
if (useSearchContext().enabled) return children;
|
|
59
61
|
}
|
|
62
|
+
|
|
63
|
+
//#endregion
|
|
64
|
+
export { SearchOnly, SearchProvider, useSearchContext };
|
|
65
|
+
//# sourceMappingURL=search.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"search.js","names":[],"sources":["../../src/contexts/search.tsx"],"sourcesContent":["'use client';\nimport {\n type ComponentType,\n createContext,\n type ReactNode,\n use,\n useEffect,\n useEffectEvent,\n useMemo,\n useState,\n} from 'react';\n\ninterface HotKey {\n display: ReactNode;\n\n /**\n * Key code or a function determining whether the key is pressed.\n */\n key: string | ((e: KeyboardEvent) => boolean);\n}\n\nexport interface SharedProps {\n open: boolean;\n onOpenChange: (open: boolean) => void;\n}\n\nexport type SearchLink = [name: string, href: string];\n\nexport interface TagItem {\n name: string;\n value: string;\n}\n\nexport interface SearchProviderProps {\n /**\n * Preload search dialog before opening it\n *\n * @defaultValue `true`\n */\n preload?: boolean;\n\n /**\n * Custom links to be displayed if search is empty\n */\n links?: SearchLink[];\n\n /**\n * Hotkeys for triggering search dialog\n *\n * @defaultValue Meta/Ctrl + K\n */\n hotKey?: HotKey[];\n\n /**\n * Replace default search dialog, allowing you to use other solutions such as Algolia Search\n *\n * It receives the `open` and `onOpenChange` prop, can be lazy loaded with `next/dynamic`\n */\n SearchDialog: ComponentType<SharedProps>;\n\n /**\n * Additional props to the dialog\n */\n options?: Partial<SharedProps & Record<string, unknown>>;\n\n children?: ReactNode;\n}\n\ninterface SearchContextType {\n enabled: boolean;\n hotKey: HotKey[];\n setOpenSearch: (value: boolean) => void;\n}\n\nconst SearchContext = createContext<SearchContextType>({\n enabled: false,\n hotKey: [],\n setOpenSearch: () => undefined,\n});\n\nexport function useSearchContext(): SearchContextType {\n return use(SearchContext);\n}\n\nfunction MetaOrControl() {\n const [key, setKey] = useState('⌘');\n\n useEffect(() => {\n const isWindows = window.navigator.userAgent.includes('Windows');\n\n if (isWindows) setKey('Ctrl');\n }, []);\n\n return key;\n}\n\nexport function SearchProvider({\n SearchDialog,\n children,\n preload = true,\n options,\n hotKey = [\n {\n key: (e) => e.metaKey || e.ctrlKey,\n display: <MetaOrControl />,\n },\n {\n key: 'k',\n display: 'K',\n },\n ],\n links,\n}: SearchProviderProps) {\n const [isOpen, setIsOpen] = useState(preload ? false : undefined);\n const onKeyDown = useEffectEvent((e: KeyboardEvent) => {\n if (hotKey.every((v) => (typeof v.key === 'string' ? e.key === v.key : v.key(e)))) {\n setIsOpen((open) => !open);\n e.preventDefault();\n }\n });\n\n useEffect(() => {\n window.addEventListener('keydown', onKeyDown);\n return () => {\n window.removeEventListener('keydown', onKeyDown);\n };\n }, [hotKey]);\n\n return (\n <SearchContext\n value={useMemo(\n () => ({\n enabled: true,\n hotKey,\n setOpenSearch: setIsOpen,\n }),\n [hotKey],\n )}\n >\n {isOpen !== undefined && (\n <SearchDialog\n open={isOpen}\n onOpenChange={setIsOpen}\n // @ts-expect-error -- insert prop for official UIs\n links={links}\n {...options}\n />\n )}\n {children}\n </SearchContext>\n );\n}\n\n/**\n * Show children only when search is enabled via React Context\n */\nexport function SearchOnly({ children }: { children: ReactNode }) {\n const search = useSearchContext();\n\n if (search.enabled) return children;\n}\n"],"mappings":";;;;;;AA0EA,MAAM,gBAAgB,cAAiC;CACrD,SAAS;CACT,QAAQ,EAAE;CACV,qBAAqB;CACtB,CAAC;AAEF,SAAgB,mBAAsC;AACpD,QAAO,IAAI,cAAc;;AAG3B,SAAS,gBAAgB;CACvB,MAAM,CAAC,KAAK,UAAU,SAAS,IAAI;AAEnC,iBAAgB;AAGd,MAFkB,OAAO,UAAU,UAAU,SAAS,UAAU,CAEjD,QAAO,OAAO;IAC5B,EAAE,CAAC;AAEN,QAAO;;AAGT,SAAgB,eAAe,EAC7B,cACA,UACA,UAAU,MACV,SACA,SAAS,CACP;CACE,MAAM,MAAM,EAAE,WAAW,EAAE;CAC3B,SAAS,oBAAC,kBAAgB;CAC3B,EACD;CACE,KAAK;CACL,SAAS;CACV,CACF,EACD,SACsB;CACtB,MAAM,CAAC,QAAQ,aAAa,SAAS,UAAU,QAAQ,OAAU;CACjE,MAAM,YAAY,gBAAgB,MAAqB;AACrD,MAAI,OAAO,OAAO,MAAO,OAAO,EAAE,QAAQ,WAAW,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,CAAE,EAAE;AACjF,cAAW,SAAS,CAAC,KAAK;AAC1B,KAAE,gBAAgB;;GAEpB;AAEF,iBAAgB;AACd,SAAO,iBAAiB,WAAW,UAAU;AAC7C,eAAa;AACX,UAAO,oBAAoB,WAAW,UAAU;;IAEjD,CAAC,OAAO,CAAC;AAEZ,QACE,qBAAC;EACC,OAAO,eACE;GACL,SAAS;GACT;GACA,eAAe;GAChB,GACD,CAAC,OAAO,CACT;aAEA,WAAW,UACV,oBAAC;GACC,MAAM;GACN,cAAc;GAEP;GACP,GAAI;IACJ,EAEH;GACa;;;;;AAOpB,SAAgB,WAAW,EAAE,YAAqC;AAGhE,KAFe,kBAAkB,CAEtB,QAAS,QAAO"}
|
package/dist/contexts/tree.d.ts
CHANGED
|
@@ -1,15 +1,22 @@
|
|
|
1
|
-
import
|
|
2
|
-
import
|
|
1
|
+
import { ReactNode } from "react";
|
|
2
|
+
import * as react_jsx_runtime2 from "react/jsx-runtime";
|
|
3
|
+
import * as PageTree from "fumadocs-core/page-tree";
|
|
4
|
+
|
|
5
|
+
//#region src/contexts/tree.d.ts
|
|
3
6
|
type MakeRequired<O, K extends keyof O> = Omit<O, K> & Pick<Required<O>, K>;
|
|
4
7
|
interface TreeContextType {
|
|
5
|
-
|
|
6
|
-
|
|
8
|
+
root: MakeRequired<PageTree.Root | PageTree.Folder, '$id'>;
|
|
9
|
+
full: PageTree.Root;
|
|
7
10
|
}
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
}
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
11
|
+
declare function TreeContextProvider({
|
|
12
|
+
tree: rawTree,
|
|
13
|
+
children
|
|
14
|
+
}: {
|
|
15
|
+
tree: PageTree.Root;
|
|
16
|
+
children: ReactNode;
|
|
17
|
+
}): react_jsx_runtime2.JSX.Element;
|
|
18
|
+
declare function useTreePath(): PageTree.Node[];
|
|
19
|
+
declare function useTreeContext(): TreeContextType;
|
|
20
|
+
//#endregion
|
|
21
|
+
export { TreeContextProvider, useTreeContext, useTreePath };
|
|
15
22
|
//# sourceMappingURL=tree.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"tree.d.ts","
|
|
1
|
+
{"version":3,"file":"tree.d.ts","names":[],"sources":["../../src/contexts/tree.tsx"],"sourcesContent":[],"mappings":";;;;;KAMK,gCAAgC,KAAK,KAAK,GAAG,KAAK,KAAK,SAAS,IAAI;UAE/D,eAAA;QACF,aAAa,QAAA,CAAS,OAAO,QAAA,CAAS;EAHzC,IAAA,EAIG,QAAA,CAAS,IAJA;;AAA8B,iBAU/B,mBAAA,CAV+B;EAAA,IAAA,EAWvC,OAXuC;EAAA;CAAA,EAAA;EAAG,IAAA,EAc1C,QAAA,CAAS,IAdiC;EAAR,QAAA,EAe9B,SAf8B;CAA2B,CAAA,EAgBpE,kBAAA,CAAA,GAAA,CAAA,OAhBoE;AAAT,iBA0C5C,WAAA,CAAA,CA1C4C,EA0C7B,QAAA,CAAS,IA1CoB,EAAA;AAAa,iBA8CzD,cAAA,CAAA,CA9CyD,EA8CvC,eA9CuC"}
|
package/dist/contexts/tree.js
CHANGED
|
@@ -1,32 +1,42 @@
|
|
|
1
1
|
'use client';
|
|
2
|
-
|
|
3
|
-
import {
|
|
4
|
-
import {
|
|
5
|
-
import {
|
|
2
|
+
|
|
3
|
+
import { createContext, use, useMemo, useRef } from "react";
|
|
4
|
+
import { usePathname } from "fumadocs-core/framework";
|
|
5
|
+
import { jsx } from "react/jsx-runtime";
|
|
6
|
+
import { searchPath } from "fumadocs-core/breadcrumb";
|
|
7
|
+
|
|
8
|
+
//#region src/contexts/tree.tsx
|
|
6
9
|
const TreeContext = createContext(null);
|
|
7
10
|
const PathContext = createContext([]);
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
11
|
+
function TreeContextProvider({ tree: rawTree, children }) {
|
|
12
|
+
const nextIdRef = useRef(0);
|
|
13
|
+
const pathname = usePathname();
|
|
14
|
+
const tree = useMemo(() => rawTree, [rawTree.$id ?? rawTree]);
|
|
15
|
+
const path = useMemo(() => {
|
|
16
|
+
return searchPath(tree.children, pathname) ?? (tree.fallback ? searchPath(tree.fallback.children, pathname) : null) ?? [];
|
|
17
|
+
}, [tree, pathname]);
|
|
18
|
+
const root = path.findLast((item) => item.type === "folder" && item.root) ?? tree;
|
|
19
|
+
root.$id ??= String(nextIdRef.current++);
|
|
20
|
+
return /* @__PURE__ */ jsx(TreeContext, {
|
|
21
|
+
value: useMemo(() => ({
|
|
22
|
+
root,
|
|
23
|
+
full: tree
|
|
24
|
+
}), [root, tree]),
|
|
25
|
+
children: /* @__PURE__ */ jsx(PathContext, {
|
|
26
|
+
value: path,
|
|
27
|
+
children
|
|
28
|
+
})
|
|
29
|
+
});
|
|
23
30
|
}
|
|
24
|
-
|
|
25
|
-
|
|
31
|
+
function useTreePath() {
|
|
32
|
+
return use(PathContext);
|
|
26
33
|
}
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
return ctx;
|
|
34
|
+
function useTreeContext() {
|
|
35
|
+
const ctx = use(TreeContext);
|
|
36
|
+
if (!ctx) throw new Error("You must wrap this component under <DocsLayout />");
|
|
37
|
+
return ctx;
|
|
32
38
|
}
|
|
39
|
+
|
|
40
|
+
//#endregion
|
|
41
|
+
export { TreeContextProvider, useTreeContext, useTreePath };
|
|
42
|
+
//# sourceMappingURL=tree.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tree.js","names":[],"sources":["../../src/contexts/tree.tsx"],"sourcesContent":["'use client';\nimport type * as PageTree from 'fumadocs-core/page-tree';\nimport { usePathname } from 'fumadocs-core/framework';\nimport { type ReactNode, useMemo, useRef, createContext, use } from 'react';\nimport { searchPath } from 'fumadocs-core/breadcrumb';\n\ntype MakeRequired<O, K extends keyof O> = Omit<O, K> & Pick<Required<O>, K>;\n\ninterface TreeContextType {\n root: MakeRequired<PageTree.Root | PageTree.Folder, '$id'>;\n full: PageTree.Root;\n}\n\nconst TreeContext = createContext<TreeContextType | null>(null);\nconst PathContext = createContext<PageTree.Node[]>([]);\n\nexport function TreeContextProvider({\n tree: rawTree,\n children,\n}: {\n tree: PageTree.Root;\n children: ReactNode;\n}) {\n const nextIdRef = useRef(0);\n const pathname = usePathname();\n\n // I found that object-typed props passed from a RSC will be re-constructed, hence breaking all hooks' dependencies\n // using the id here to make sure this never happens\n // eslint-disable-next-line react-hooks/exhaustive-deps\n const tree = useMemo(() => rawTree, [rawTree.$id ?? rawTree]);\n const path = useMemo(() => {\n return (\n searchPath(tree.children, pathname) ??\n (tree.fallback ? searchPath(tree.fallback.children, pathname) : null) ??\n []\n );\n }, [tree, pathname]);\n\n const root = path.findLast((item) => item.type === 'folder' && item.root) ?? tree;\n root.$id ??= String(nextIdRef.current++);\n\n return (\n <TreeContext value={useMemo(() => ({ root, full: tree }) as TreeContextType, [root, tree])}>\n <PathContext value={path}>{children}</PathContext>\n </TreeContext>\n );\n}\n\nexport function useTreePath(): PageTree.Node[] {\n return use(PathContext);\n}\n\nexport function useTreeContext(): TreeContextType {\n const ctx = use(TreeContext);\n\n if (!ctx) throw new Error('You must wrap this component under <DocsLayout />');\n return ctx;\n}\n"],"mappings":";;;;;;;;AAaA,MAAM,cAAc,cAAsC,KAAK;AAC/D,MAAM,cAAc,cAA+B,EAAE,CAAC;AAEtD,SAAgB,oBAAoB,EAClC,MAAM,SACN,YAIC;CACD,MAAM,YAAY,OAAO,EAAE;CAC3B,MAAM,WAAW,aAAa;CAK9B,MAAM,OAAO,cAAc,SAAS,CAAC,QAAQ,OAAO,QAAQ,CAAC;CAC7D,MAAM,OAAO,cAAc;AACzB,SACE,WAAW,KAAK,UAAU,SAAS,KAClC,KAAK,WAAW,WAAW,KAAK,SAAS,UAAU,SAAS,GAAG,SAChE,EAAE;IAEH,CAAC,MAAM,SAAS,CAAC;CAEpB,MAAM,OAAO,KAAK,UAAU,SAAS,KAAK,SAAS,YAAY,KAAK,KAAK,IAAI;AAC7E,MAAK,QAAQ,OAAO,UAAU,UAAU;AAExC,QACE,oBAAC;EAAY,OAAO,eAAe;GAAE;GAAM,MAAM;GAAM,GAAsB,CAAC,MAAM,KAAK,CAAC;YACxF,oBAAC;GAAY,OAAO;GAAO;IAAuB;GACtC;;AAIlB,SAAgB,cAA+B;AAC7C,QAAO,IAAI,YAAY;;AAGzB,SAAgB,iBAAkC;CAChD,MAAM,MAAM,IAAI,YAAY;AAE5B,KAAI,CAAC,IAAK,OAAM,IAAI,MAAM,oDAAoD;AAC9E,QAAO"}
|