@hanzo/ui 5.3.26 → 5.3.29
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/content/index.ts +26 -0
- package/dist/util/index.js +6 -0
- package/dist/util/index.mjs +6 -1
- package/docs/_registry/index.ts +426 -0
- package/docs/_registry/layout/docs-min.tsx +197 -0
- package/docs/_registry/layout/page-min.tsx +128 -0
- package/docs/components/accordion.tsx +118 -0
- package/docs/components/banner.tsx +144 -0
- package/docs/components/callout.tsx +112 -0
- package/docs/components/card.tsx +52 -0
- package/docs/components/codeblock.tsx +258 -0
- package/docs/components/dialog/search-algolia.tsx +132 -0
- package/docs/components/dialog/search-default.tsx +131 -0
- package/docs/components/dialog/search-orama.tsx +143 -0
- package/docs/components/dialog/search.tsx +529 -0
- package/docs/components/dynamic-codeblock.tsx +129 -0
- package/docs/components/files.tsx +81 -0
- package/docs/components/github-info.tsx +107 -0
- package/docs/components/heading.tsx +33 -0
- package/docs/components/image-zoom.css +77 -0
- package/docs/components/image-zoom.tsx +58 -0
- package/docs/components/index.ts +7 -0
- package/docs/components/inline-toc.tsx +48 -0
- package/docs/components/sidebar/base.tsx +451 -0
- package/docs/components/sidebar/link-item.tsx +65 -0
- package/docs/components/sidebar/page-tree.tsx +113 -0
- package/docs/components/sidebar/tabs/dropdown.tsx +109 -0
- package/docs/components/sidebar/tabs/index.tsx +89 -0
- package/docs/components/steps.tsx +9 -0
- package/docs/components/tabs.tsx +203 -0
- package/docs/components/toc/clerk.tsx +173 -0
- package/docs/components/toc/default.tsx +57 -0
- package/docs/components/toc/index.tsx +136 -0
- package/docs/components/type-table.tsx +174 -0
- package/docs/components/ui/accordion.tsx +88 -0
- package/docs/components/ui/button.tsx +28 -0
- package/docs/components/ui/collapsible.tsx +42 -0
- package/docs/components/ui/navigation-menu.tsx +83 -0
- package/docs/components/ui/popover.tsx +32 -0
- package/docs/components/ui/scroll-area.tsx +59 -0
- package/docs/components/ui/tabs.tsx +145 -0
- package/docs/contexts/i18n.tsx +56 -0
- package/docs/contexts/search.tsx +165 -0
- package/docs/contexts/tree.tsx +65 -0
- package/docs/css/black.css +39 -0
- package/docs/css/catppuccin.css +49 -0
- package/docs/css/colors/index.css +51 -0
- package/docs/css/dusk.css +47 -0
- package/docs/css/layouts/docs.css +1 -0
- package/docs/css/layouts/home.css +1 -0
- package/docs/css/layouts/notebook.css +1 -0
- package/docs/css/neutral.css +7 -0
- package/docs/css/ocean.css +48 -0
- package/docs/css/preset.css +305 -0
- package/docs/css/purple.css +39 -0
- package/docs/css/shadcn.css +36 -0
- package/docs/css/shiki.css +90 -0
- package/docs/css/solar.css +75 -0
- package/docs/css/style.css +9 -0
- package/docs/css/vitepress.css +77 -0
- package/docs/i18n.tsx +30 -0
- package/docs/icons.tsx +354 -0
- package/docs/layouts/docs/client.tsx +129 -0
- package/docs/layouts/docs/index.tsx +321 -0
- package/docs/layouts/docs/page/client.tsx +376 -0
- package/docs/layouts/docs/page/index.tsx +251 -0
- package/docs/layouts/docs/sidebar.tsx +265 -0
- package/docs/layouts/home/client.tsx +375 -0
- package/docs/layouts/home/index.tsx +51 -0
- package/docs/layouts/home/navbar.tsx +55 -0
- package/docs/layouts/notebook/client.tsx +281 -0
- package/docs/layouts/notebook/index.tsx +461 -0
- package/docs/layouts/notebook/page/client.tsx +375 -0
- package/docs/layouts/notebook/page/index.tsx +251 -0
- package/docs/layouts/notebook/sidebar.tsx +248 -0
- package/docs/layouts/shared/index.tsx +89 -0
- package/docs/layouts/shared/language-toggle.tsx +66 -0
- package/docs/layouts/shared/link-item.tsx +119 -0
- package/docs/layouts/shared/search-toggle.tsx +78 -0
- package/docs/layouts/shared/theme-toggle.tsx +86 -0
- package/docs/mdx.server.tsx +37 -0
- package/docs/mdx.tsx +97 -0
- package/docs/og.tsx +101 -0
- package/docs/page.tsx +85 -0
- package/docs/provider/base.tsx +173 -0
- package/docs/provider/next.tsx +23 -0
- package/docs/provider/react-router.tsx +23 -0
- package/docs/provider/tanstack.tsx +23 -0
- package/docs/provider/waku.tsx +23 -0
- package/docs/source.ts +3 -0
- package/docs/theme/typography/LICENSE +21 -0
- package/docs/theme/typography/index.ts +201 -0
- package/docs/theme/typography/styles.ts +449 -0
- package/docs/utils/cn.ts +1 -0
- package/docs/utils/is-active.ts +23 -0
- package/docs/utils/merge-refs.ts +15 -0
- package/docs/utils/use-copy-button.ts +39 -0
- package/docs/utils/use-footer-items.ts +27 -0
- package/docs/utils/use-is-scroll-top.ts +21 -0
- package/package.json +4 -2
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
'use client';
|
|
2
|
+
import { Check, ChevronsUpDown } from '@icons';
|
|
3
|
+
import { type ComponentProps, type ReactNode, useMemo, useState } from 'react';
|
|
4
|
+
import Link from '@hanzo/docs-core/link';
|
|
5
|
+
import { usePathname } from '@hanzo/docs-core/framework';
|
|
6
|
+
import { cn } from '@/utils/cn';
|
|
7
|
+
import { isTabActive } from '@/utils/is-active';
|
|
8
|
+
import { useSidebar } from '@/components/sidebar/base';
|
|
9
|
+
import {
|
|
10
|
+
Popover,
|
|
11
|
+
PopoverContent,
|
|
12
|
+
PopoverTrigger,
|
|
13
|
+
} from '@/components/ui/popover';
|
|
14
|
+
import type { SidebarTab } from '.';
|
|
15
|
+
|
|
16
|
+
export interface SidebarTabWithProps extends SidebarTab {
|
|
17
|
+
props?: ComponentProps<'a'>;
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
export function SidebarTabsDropdown({
|
|
21
|
+
options,
|
|
22
|
+
placeholder,
|
|
23
|
+
...props
|
|
24
|
+
}: {
|
|
25
|
+
placeholder?: ReactNode;
|
|
26
|
+
options: SidebarTabWithProps[];
|
|
27
|
+
} & ComponentProps<'button'>) {
|
|
28
|
+
const [open, setOpen] = useState(false);
|
|
29
|
+
const { closeOnRedirect } = useSidebar();
|
|
30
|
+
const pathname = usePathname();
|
|
31
|
+
|
|
32
|
+
const selected = useMemo(() => {
|
|
33
|
+
return options.findLast((item) => isTabActive(item, pathname));
|
|
34
|
+
}, [options, pathname]);
|
|
35
|
+
|
|
36
|
+
const onClick = () => {
|
|
37
|
+
closeOnRedirect.current = false;
|
|
38
|
+
setOpen(false);
|
|
39
|
+
};
|
|
40
|
+
|
|
41
|
+
const item = selected ? (
|
|
42
|
+
<>
|
|
43
|
+
<div className="size-9 shrink-0 empty:hidden md:size-5">
|
|
44
|
+
{selected.icon}
|
|
45
|
+
</div>
|
|
46
|
+
<div>
|
|
47
|
+
<p className="text-sm font-medium">{selected.title}</p>
|
|
48
|
+
<p className="text-sm text-fd-muted-foreground empty:hidden md:hidden">
|
|
49
|
+
{selected.description}
|
|
50
|
+
</p>
|
|
51
|
+
</div>
|
|
52
|
+
</>
|
|
53
|
+
) : (
|
|
54
|
+
placeholder
|
|
55
|
+
);
|
|
56
|
+
|
|
57
|
+
return (
|
|
58
|
+
<Popover open={open} onOpenChange={setOpen}>
|
|
59
|
+
{item && (
|
|
60
|
+
<PopoverTrigger
|
|
61
|
+
{...props}
|
|
62
|
+
className={cn(
|
|
63
|
+
'flex items-center gap-2 rounded-lg p-2 border bg-fd-secondary/50 text-start text-fd-secondary-foreground transition-colors hover:bg-fd-accent data-[state=open]:bg-fd-accent data-[state=open]:text-fd-accent-foreground',
|
|
64
|
+
props.className,
|
|
65
|
+
)}
|
|
66
|
+
>
|
|
67
|
+
{item}
|
|
68
|
+
<ChevronsUpDown className="shrink-0 ms-auto size-4 text-fd-muted-foreground" />
|
|
69
|
+
</PopoverTrigger>
|
|
70
|
+
)}
|
|
71
|
+
<PopoverContent className="flex flex-col gap-1 w-(--radix-popover-trigger-width) p-1 fd-scroll-container">
|
|
72
|
+
{options.map((item) => {
|
|
73
|
+
const isActive = selected && item.url === selected.url;
|
|
74
|
+
if (!isActive && item.unlisted) return;
|
|
75
|
+
|
|
76
|
+
return (
|
|
77
|
+
<Link
|
|
78
|
+
key={item.url}
|
|
79
|
+
href={item.url}
|
|
80
|
+
onClick={onClick}
|
|
81
|
+
{...item.props}
|
|
82
|
+
className={cn(
|
|
83
|
+
'flex items-center gap-2 rounded-lg p-1.5 hover:bg-fd-accent hover:text-fd-accent-foreground',
|
|
84
|
+
item.props?.className,
|
|
85
|
+
)}
|
|
86
|
+
>
|
|
87
|
+
<div className="shrink-0 size-9 md:mt-1 md:mb-auto md:size-5 empty:hidden">
|
|
88
|
+
{item.icon}
|
|
89
|
+
</div>
|
|
90
|
+
<div>
|
|
91
|
+
<p className="text-sm font-medium">{item.title}</p>
|
|
92
|
+
<p className="text-[0.8125rem] text-fd-muted-foreground empty:hidden">
|
|
93
|
+
{item.description}
|
|
94
|
+
</p>
|
|
95
|
+
</div>
|
|
96
|
+
|
|
97
|
+
<Check
|
|
98
|
+
className={cn(
|
|
99
|
+
'shrink-0 ms-auto size-3.5 text-fd-primary',
|
|
100
|
+
!isActive && 'invisible',
|
|
101
|
+
)}
|
|
102
|
+
/>
|
|
103
|
+
</Link>
|
|
104
|
+
);
|
|
105
|
+
})}
|
|
106
|
+
</PopoverContent>
|
|
107
|
+
</Popover>
|
|
108
|
+
);
|
|
109
|
+
}
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
import type * as PageTree from '@hanzo/docs-core/page-tree';
|
|
2
|
+
import type { ReactNode } from 'react';
|
|
3
|
+
|
|
4
|
+
export interface SidebarTab {
|
|
5
|
+
/**
|
|
6
|
+
* Redirect URL of the folder, usually the index page
|
|
7
|
+
*/
|
|
8
|
+
url: string;
|
|
9
|
+
|
|
10
|
+
icon?: ReactNode;
|
|
11
|
+
title: ReactNode;
|
|
12
|
+
description?: ReactNode;
|
|
13
|
+
|
|
14
|
+
/**
|
|
15
|
+
* Detect from a list of urls
|
|
16
|
+
*/
|
|
17
|
+
urls?: Set<string>;
|
|
18
|
+
unlisted?: boolean;
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
export interface GetSidebarTabsOptions {
|
|
22
|
+
transform?: (option: SidebarTab, node: PageTree.Folder) => SidebarTab | null;
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
const defaultTransform: GetSidebarTabsOptions['transform'] = (option, node) => {
|
|
26
|
+
if (!node.icon) return option;
|
|
27
|
+
|
|
28
|
+
return {
|
|
29
|
+
...option,
|
|
30
|
+
icon: (
|
|
31
|
+
<div className="size-full [&_svg]:size-full max-md:p-1.5 max-md:rounded-md max-md:border max-md:bg-fd-secondary">
|
|
32
|
+
{node.icon}
|
|
33
|
+
</div>
|
|
34
|
+
),
|
|
35
|
+
};
|
|
36
|
+
};
|
|
37
|
+
|
|
38
|
+
export function getSidebarTabs(
|
|
39
|
+
tree: PageTree.Root,
|
|
40
|
+
{ transform = defaultTransform }: GetSidebarTabsOptions = {},
|
|
41
|
+
): SidebarTab[] {
|
|
42
|
+
const results: SidebarTab[] = [];
|
|
43
|
+
|
|
44
|
+
function scanOptions(
|
|
45
|
+
node: PageTree.Root | PageTree.Folder,
|
|
46
|
+
unlisted?: boolean,
|
|
47
|
+
) {
|
|
48
|
+
if ('root' in node && node.root) {
|
|
49
|
+
const urls = getFolderUrls(node);
|
|
50
|
+
|
|
51
|
+
if (urls.size > 0) {
|
|
52
|
+
const option: SidebarTab = {
|
|
53
|
+
url: urls.values().next().value ?? '',
|
|
54
|
+
title: node.name,
|
|
55
|
+
icon: node.icon,
|
|
56
|
+
unlisted,
|
|
57
|
+
description: node.description,
|
|
58
|
+
urls,
|
|
59
|
+
};
|
|
60
|
+
|
|
61
|
+
const mapped = transform ? transform(option, node) : option;
|
|
62
|
+
if (mapped) results.push(mapped);
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
for (const child of node.children) {
|
|
67
|
+
if (child.type === 'folder') scanOptions(child, unlisted);
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
scanOptions(tree);
|
|
72
|
+
if (tree.fallback) scanOptions(tree.fallback, true);
|
|
73
|
+
|
|
74
|
+
return results;
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
function getFolderUrls(
|
|
78
|
+
folder: PageTree.Folder,
|
|
79
|
+
output: Set<string> = new Set(),
|
|
80
|
+
): Set<string> {
|
|
81
|
+
if (folder.index) output.add(folder.index.url);
|
|
82
|
+
|
|
83
|
+
for (const child of folder.children) {
|
|
84
|
+
if (child.type === 'page' && !child.external) output.add(child.url);
|
|
85
|
+
if (child.type === 'folder') getFolderUrls(child, output);
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
return output;
|
|
89
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type { ReactNode } from 'react';
|
|
2
|
+
|
|
3
|
+
export function Steps({ children }: { children: ReactNode }) {
|
|
4
|
+
return <div className="fd-steps">{children}</div>;
|
|
5
|
+
}
|
|
6
|
+
|
|
7
|
+
export function Step({ children }: { children: ReactNode }) {
|
|
8
|
+
return <div className="fd-step">{children}</div>;
|
|
9
|
+
}
|
|
@@ -0,0 +1,203 @@
|
|
|
1
|
+
'use client';
|
|
2
|
+
|
|
3
|
+
import * as React from 'react';
|
|
4
|
+
import {
|
|
5
|
+
type ComponentProps,
|
|
6
|
+
createContext,
|
|
7
|
+
type ReactNode,
|
|
8
|
+
useContext,
|
|
9
|
+
useEffect,
|
|
10
|
+
useId,
|
|
11
|
+
useMemo,
|
|
12
|
+
useState,
|
|
13
|
+
} from 'react';
|
|
14
|
+
import { cn } from '@/utils/cn';
|
|
15
|
+
import * as Unstyled from './ui/tabs';
|
|
16
|
+
|
|
17
|
+
type CollectionKey = string | symbol;
|
|
18
|
+
|
|
19
|
+
export interface TabsProps extends Omit<
|
|
20
|
+
ComponentProps<typeof Unstyled.Tabs>,
|
|
21
|
+
'value' | 'onValueChange'
|
|
22
|
+
> {
|
|
23
|
+
/**
|
|
24
|
+
* Use simple mode instead of advanced usage as documented in https://radix-ui.com/primitives/docs/components/tabs.
|
|
25
|
+
*/
|
|
26
|
+
items?: string[];
|
|
27
|
+
|
|
28
|
+
/**
|
|
29
|
+
* Shortcut for `defaultValue` when `items` is provided.
|
|
30
|
+
*
|
|
31
|
+
* @defaultValue 0
|
|
32
|
+
*/
|
|
33
|
+
defaultIndex?: number;
|
|
34
|
+
|
|
35
|
+
/**
|
|
36
|
+
* Additional label in tabs list when `items` is provided.
|
|
37
|
+
*/
|
|
38
|
+
label?: ReactNode;
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
const TabsContext = createContext<{
|
|
42
|
+
items?: string[];
|
|
43
|
+
collection: CollectionKey[];
|
|
44
|
+
} | null>(null);
|
|
45
|
+
|
|
46
|
+
function useTabContext() {
|
|
47
|
+
const ctx = useContext(TabsContext);
|
|
48
|
+
if (!ctx) throw new Error('You must wrap your component in <Tabs>');
|
|
49
|
+
return ctx;
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
export const TabsList = React.forwardRef<
|
|
53
|
+
React.ComponentRef<typeof Unstyled.TabsList>,
|
|
54
|
+
React.ComponentPropsWithoutRef<typeof Unstyled.TabsList>
|
|
55
|
+
>((props, ref) => (
|
|
56
|
+
<Unstyled.TabsList
|
|
57
|
+
ref={ref}
|
|
58
|
+
{...props}
|
|
59
|
+
className={cn(
|
|
60
|
+
'flex gap-3.5 text-fd-secondary-foreground overflow-x-auto px-4 not-prose',
|
|
61
|
+
props.className,
|
|
62
|
+
)}
|
|
63
|
+
/>
|
|
64
|
+
));
|
|
65
|
+
TabsList.displayName = 'TabsList';
|
|
66
|
+
|
|
67
|
+
export const TabsTrigger = React.forwardRef<
|
|
68
|
+
React.ComponentRef<typeof Unstyled.TabsTrigger>,
|
|
69
|
+
React.ComponentPropsWithoutRef<typeof Unstyled.TabsTrigger>
|
|
70
|
+
>((props, ref) => (
|
|
71
|
+
<Unstyled.TabsTrigger
|
|
72
|
+
ref={ref}
|
|
73
|
+
{...props}
|
|
74
|
+
className={cn(
|
|
75
|
+
'inline-flex items-center gap-2 whitespace-nowrap text-fd-muted-foreground border-b border-transparent py-2 text-sm font-medium transition-colors [&_svg]:size-4 hover:text-fd-accent-foreground disabled:pointer-events-none disabled:opacity-50 data-[state=active]:border-fd-primary data-[state=active]:text-fd-primary',
|
|
76
|
+
props.className,
|
|
77
|
+
)}
|
|
78
|
+
/>
|
|
79
|
+
));
|
|
80
|
+
TabsTrigger.displayName = 'TabsTrigger';
|
|
81
|
+
|
|
82
|
+
export function Tabs({
|
|
83
|
+
ref,
|
|
84
|
+
className,
|
|
85
|
+
items,
|
|
86
|
+
label,
|
|
87
|
+
defaultIndex = 0,
|
|
88
|
+
defaultValue = items ? escapeValue(items[defaultIndex]) : undefined,
|
|
89
|
+
...props
|
|
90
|
+
}: TabsProps) {
|
|
91
|
+
const [value, setValue] = useState(defaultValue);
|
|
92
|
+
const collection = useMemo<CollectionKey[]>(() => [], []);
|
|
93
|
+
|
|
94
|
+
return (
|
|
95
|
+
<Unstyled.Tabs
|
|
96
|
+
ref={ref}
|
|
97
|
+
className={cn(
|
|
98
|
+
'flex flex-col overflow-hidden rounded-xl border bg-fd-secondary my-4',
|
|
99
|
+
className,
|
|
100
|
+
)}
|
|
101
|
+
value={value}
|
|
102
|
+
onValueChange={(v: string) => {
|
|
103
|
+
if (items && !items.some((item) => escapeValue(item) === v)) return;
|
|
104
|
+
setValue(v);
|
|
105
|
+
}}
|
|
106
|
+
{...props}
|
|
107
|
+
>
|
|
108
|
+
{items && (
|
|
109
|
+
<TabsList>
|
|
110
|
+
{label && (
|
|
111
|
+
<span className="text-sm font-medium my-auto me-auto">{label}</span>
|
|
112
|
+
)}
|
|
113
|
+
{items.map((item) => (
|
|
114
|
+
<TabsTrigger key={item} value={escapeValue(item)}>
|
|
115
|
+
{item}
|
|
116
|
+
</TabsTrigger>
|
|
117
|
+
))}
|
|
118
|
+
</TabsList>
|
|
119
|
+
)}
|
|
120
|
+
<TabsContext.Provider
|
|
121
|
+
value={useMemo(() => ({ items, collection }), [collection, items])}
|
|
122
|
+
>
|
|
123
|
+
{props.children}
|
|
124
|
+
</TabsContext.Provider>
|
|
125
|
+
</Unstyled.Tabs>
|
|
126
|
+
);
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
export interface TabProps extends Omit<
|
|
130
|
+
ComponentProps<typeof Unstyled.TabsContent>,
|
|
131
|
+
'value'
|
|
132
|
+
> {
|
|
133
|
+
/**
|
|
134
|
+
* Value of tab, detect from index if unspecified.
|
|
135
|
+
*/
|
|
136
|
+
value?: string;
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
export function Tab({ value, ...props }: TabProps) {
|
|
140
|
+
const { items } = useTabContext();
|
|
141
|
+
const resolved =
|
|
142
|
+
value ??
|
|
143
|
+
// eslint-disable-next-line react-hooks/rules-of-hooks -- `value` is not supposed to change
|
|
144
|
+
items?.at(useCollectionIndex());
|
|
145
|
+
if (!resolved)
|
|
146
|
+
throw new Error(
|
|
147
|
+
'Failed to resolve tab `value`, please pass a `value` prop to the Tab component.',
|
|
148
|
+
);
|
|
149
|
+
|
|
150
|
+
return (
|
|
151
|
+
<TabsContent value={escapeValue(resolved)} {...props}>
|
|
152
|
+
{props.children}
|
|
153
|
+
</TabsContent>
|
|
154
|
+
);
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
export function TabsContent({
|
|
158
|
+
value,
|
|
159
|
+
className,
|
|
160
|
+
...props
|
|
161
|
+
}: ComponentProps<typeof Unstyled.TabsContent>) {
|
|
162
|
+
return (
|
|
163
|
+
<Unstyled.TabsContent
|
|
164
|
+
value={value}
|
|
165
|
+
forceMount
|
|
166
|
+
className={cn(
|
|
167
|
+
'p-4 text-[0.9375rem] bg-fd-background rounded-xl outline-none prose-no-margin data-[state=inactive]:hidden [&>figure:only-child]:-m-4 [&>figure:only-child]:border-none',
|
|
168
|
+
className,
|
|
169
|
+
)}
|
|
170
|
+
{...props}
|
|
171
|
+
>
|
|
172
|
+
{props.children}
|
|
173
|
+
</Unstyled.TabsContent>
|
|
174
|
+
);
|
|
175
|
+
}
|
|
176
|
+
|
|
177
|
+
/**
|
|
178
|
+
* Inspired by Headless UI.
|
|
179
|
+
*
|
|
180
|
+
* Return the index of children, this is made possible by registering the order of render from children using React context.
|
|
181
|
+
* This is supposed by work with pre-rendering & pure client-side rendering.
|
|
182
|
+
*/
|
|
183
|
+
function useCollectionIndex() {
|
|
184
|
+
const key = useId();
|
|
185
|
+
const { collection } = useTabContext();
|
|
186
|
+
|
|
187
|
+
useEffect(() => {
|
|
188
|
+
return () => {
|
|
189
|
+
const idx = collection.indexOf(key);
|
|
190
|
+
if (idx !== -1) collection.splice(idx, 1);
|
|
191
|
+
};
|
|
192
|
+
}, [key, collection]);
|
|
193
|
+
|
|
194
|
+
if (!collection.includes(key)) collection.push(key);
|
|
195
|
+
return collection.indexOf(key);
|
|
196
|
+
}
|
|
197
|
+
|
|
198
|
+
/**
|
|
199
|
+
* only escape whitespaces in values in simple mode
|
|
200
|
+
*/
|
|
201
|
+
function escapeValue(v: string): string {
|
|
202
|
+
return v.toLowerCase().replace(/\s/, '-');
|
|
203
|
+
}
|
|
@@ -0,0 +1,173 @@
|
|
|
1
|
+
'use client';
|
|
2
|
+
import * as Primitive from '@hanzo/docs-core/toc';
|
|
3
|
+
import { type ComponentProps, useEffect, useRef, useState } from 'react';
|
|
4
|
+
import { cn } from '@/utils/cn';
|
|
5
|
+
import { useTOCItems, TocThumb } from '.';
|
|
6
|
+
import { mergeRefs } from '@/utils/merge-refs';
|
|
7
|
+
import { useI18n } from '@/contexts/i18n';
|
|
8
|
+
|
|
9
|
+
export function TOCItems({ ref, className, ...props }: ComponentProps<'div'>) {
|
|
10
|
+
const containerRef = useRef<HTMLDivElement>(null);
|
|
11
|
+
const items = useTOCItems();
|
|
12
|
+
const { text } = useI18n();
|
|
13
|
+
|
|
14
|
+
const [svg, setSvg] = useState<{
|
|
15
|
+
path: string;
|
|
16
|
+
width: number;
|
|
17
|
+
height: number;
|
|
18
|
+
}>();
|
|
19
|
+
|
|
20
|
+
useEffect(() => {
|
|
21
|
+
if (!containerRef.current) return;
|
|
22
|
+
const container = containerRef.current;
|
|
23
|
+
|
|
24
|
+
function onResize(): void {
|
|
25
|
+
if (container.clientHeight === 0) return;
|
|
26
|
+
let w = 0,
|
|
27
|
+
h = 0;
|
|
28
|
+
const d: string[] = [];
|
|
29
|
+
for (let i = 0; i < items.length; i++) {
|
|
30
|
+
const element: HTMLElement | null = container.querySelector(
|
|
31
|
+
`a[href="#${items[i].url.slice(1)}"]`,
|
|
32
|
+
);
|
|
33
|
+
if (!element) continue;
|
|
34
|
+
|
|
35
|
+
const styles = getComputedStyle(element);
|
|
36
|
+
const offset = getLineOffset(items[i].depth) + 1,
|
|
37
|
+
top = element.offsetTop + parseFloat(styles.paddingTop),
|
|
38
|
+
bottom =
|
|
39
|
+
element.offsetTop +
|
|
40
|
+
element.clientHeight -
|
|
41
|
+
parseFloat(styles.paddingBottom);
|
|
42
|
+
|
|
43
|
+
w = Math.max(offset, w);
|
|
44
|
+
h = Math.max(h, bottom);
|
|
45
|
+
|
|
46
|
+
d.push(`${i === 0 ? 'M' : 'L'}${offset} ${top}`);
|
|
47
|
+
d.push(`L${offset} ${bottom}`);
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
setSvg({
|
|
51
|
+
path: d.join(' '),
|
|
52
|
+
width: w + 1,
|
|
53
|
+
height: h,
|
|
54
|
+
});
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
const observer = new ResizeObserver(onResize);
|
|
58
|
+
onResize();
|
|
59
|
+
|
|
60
|
+
observer.observe(container);
|
|
61
|
+
return () => {
|
|
62
|
+
observer.disconnect();
|
|
63
|
+
};
|
|
64
|
+
}, [items]);
|
|
65
|
+
|
|
66
|
+
if (items.length === 0)
|
|
67
|
+
return (
|
|
68
|
+
<div className="rounded-lg border bg-fd-card p-3 text-xs text-fd-muted-foreground">
|
|
69
|
+
{text.tocNoHeadings}
|
|
70
|
+
</div>
|
|
71
|
+
);
|
|
72
|
+
|
|
73
|
+
return (
|
|
74
|
+
<>
|
|
75
|
+
{svg && (
|
|
76
|
+
<div
|
|
77
|
+
className="absolute start-0 top-0 rtl:-scale-x-100"
|
|
78
|
+
style={{
|
|
79
|
+
width: svg.width,
|
|
80
|
+
height: svg.height,
|
|
81
|
+
maskImage: `url("data:image/svg+xml,${
|
|
82
|
+
// Inline SVG
|
|
83
|
+
encodeURIComponent(
|
|
84
|
+
`<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 ${svg.width} ${svg.height}"><path d="${svg.path}" stroke="black" stroke-width="1" fill="none" /></svg>`,
|
|
85
|
+
)
|
|
86
|
+
}")`,
|
|
87
|
+
}}
|
|
88
|
+
>
|
|
89
|
+
<TocThumb
|
|
90
|
+
containerRef={containerRef}
|
|
91
|
+
className="mt-(--fd-top) h-(--fd-height) bg-fd-primary transition-all"
|
|
92
|
+
/>
|
|
93
|
+
</div>
|
|
94
|
+
)}
|
|
95
|
+
<div
|
|
96
|
+
ref={mergeRefs(containerRef, ref)}
|
|
97
|
+
className={cn('flex flex-col', className)}
|
|
98
|
+
{...props}
|
|
99
|
+
>
|
|
100
|
+
{items.map((item, i) => (
|
|
101
|
+
<TOCItem
|
|
102
|
+
key={item.url}
|
|
103
|
+
item={item}
|
|
104
|
+
upper={items[i - 1]?.depth}
|
|
105
|
+
lower={items[i + 1]?.depth}
|
|
106
|
+
/>
|
|
107
|
+
))}
|
|
108
|
+
</div>
|
|
109
|
+
</>
|
|
110
|
+
);
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
function getItemOffset(depth: number): number {
|
|
114
|
+
if (depth <= 2) return 14;
|
|
115
|
+
if (depth === 3) return 26;
|
|
116
|
+
return 36;
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
function getLineOffset(depth: number): number {
|
|
120
|
+
return depth >= 3 ? 10 : 0;
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
function TOCItem({
|
|
124
|
+
item,
|
|
125
|
+
upper = item.depth,
|
|
126
|
+
lower = item.depth,
|
|
127
|
+
}: {
|
|
128
|
+
item: Primitive.TOCItemType;
|
|
129
|
+
upper?: number;
|
|
130
|
+
lower?: number;
|
|
131
|
+
}) {
|
|
132
|
+
const offset = getLineOffset(item.depth),
|
|
133
|
+
upperOffset = getLineOffset(upper),
|
|
134
|
+
lowerOffset = getLineOffset(lower);
|
|
135
|
+
|
|
136
|
+
return (
|
|
137
|
+
<Primitive.TOCItem
|
|
138
|
+
href={item.url}
|
|
139
|
+
style={{
|
|
140
|
+
paddingInlineStart: getItemOffset(item.depth),
|
|
141
|
+
}}
|
|
142
|
+
className="prose relative py-1.5 text-sm text-fd-muted-foreground hover:text-fd-accent-foreground transition-colors wrap-anywhere first:pt-0 last:pb-0 data-[active=true]:text-fd-primary"
|
|
143
|
+
>
|
|
144
|
+
{offset !== upperOffset && (
|
|
145
|
+
<svg
|
|
146
|
+
xmlns="http://www.w3.org/2000/svg"
|
|
147
|
+
viewBox="0 0 16 16"
|
|
148
|
+
className="absolute -top-1.5 start-0 size-4 rtl:-scale-x-100"
|
|
149
|
+
>
|
|
150
|
+
<line
|
|
151
|
+
x1={upperOffset}
|
|
152
|
+
y1="0"
|
|
153
|
+
x2={offset}
|
|
154
|
+
y2="12"
|
|
155
|
+
className="stroke-fd-foreground/10"
|
|
156
|
+
strokeWidth="1"
|
|
157
|
+
/>
|
|
158
|
+
</svg>
|
|
159
|
+
)}
|
|
160
|
+
<div
|
|
161
|
+
className={cn(
|
|
162
|
+
'absolute inset-y-0 w-px bg-fd-foreground/10',
|
|
163
|
+
offset !== upperOffset && 'top-1.5',
|
|
164
|
+
offset !== lowerOffset && 'bottom-1.5',
|
|
165
|
+
)}
|
|
166
|
+
style={{
|
|
167
|
+
insetInlineStart: offset,
|
|
168
|
+
}}
|
|
169
|
+
/>
|
|
170
|
+
{item.title}
|
|
171
|
+
</Primitive.TOCItem>
|
|
172
|
+
);
|
|
173
|
+
}
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
'use client';
|
|
2
|
+
import { useI18n } from '@/contexts/i18n';
|
|
3
|
+
import { cn } from '@/utils/cn';
|
|
4
|
+
import { mergeRefs } from '@/utils/merge-refs';
|
|
5
|
+
import { type ComponentProps, useRef } from 'react';
|
|
6
|
+
import { useTOCItems, TocThumb } from '.';
|
|
7
|
+
import * as Primitive from '@hanzo/docs-core/toc';
|
|
8
|
+
|
|
9
|
+
export function TOCItems({ ref, className, ...props }: ComponentProps<'div'>) {
|
|
10
|
+
const containerRef = useRef<HTMLDivElement>(null);
|
|
11
|
+
const items = useTOCItems();
|
|
12
|
+
const { text } = useI18n();
|
|
13
|
+
|
|
14
|
+
if (items.length === 0)
|
|
15
|
+
return (
|
|
16
|
+
<div className="rounded-lg border bg-fd-card p-3 text-xs text-fd-muted-foreground">
|
|
17
|
+
{text.tocNoHeadings}
|
|
18
|
+
</div>
|
|
19
|
+
);
|
|
20
|
+
|
|
21
|
+
return (
|
|
22
|
+
<>
|
|
23
|
+
<TocThumb
|
|
24
|
+
containerRef={containerRef}
|
|
25
|
+
className="absolute top-(--fd-top) h-(--fd-height) w-px bg-fd-primary transition-all"
|
|
26
|
+
/>
|
|
27
|
+
<div
|
|
28
|
+
ref={mergeRefs(ref, containerRef)}
|
|
29
|
+
className={cn(
|
|
30
|
+
'flex flex-col border-s border-fd-foreground/10',
|
|
31
|
+
className,
|
|
32
|
+
)}
|
|
33
|
+
{...props}
|
|
34
|
+
>
|
|
35
|
+
{items.map((item) => (
|
|
36
|
+
<TOCItem key={item.url} item={item} />
|
|
37
|
+
))}
|
|
38
|
+
</div>
|
|
39
|
+
</>
|
|
40
|
+
);
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
function TOCItem({ item }: { item: Primitive.TOCItemType }) {
|
|
44
|
+
return (
|
|
45
|
+
<Primitive.TOCItem
|
|
46
|
+
href={item.url}
|
|
47
|
+
className={cn(
|
|
48
|
+
'prose py-1.5 text-sm text-fd-muted-foreground transition-colors wrap-anywhere first:pt-0 last:pb-0 data-[active=true]:text-fd-primary',
|
|
49
|
+
item.depth <= 2 && 'ps-3',
|
|
50
|
+
item.depth === 3 && 'ps-6',
|
|
51
|
+
item.depth >= 4 && 'ps-8',
|
|
52
|
+
)}
|
|
53
|
+
>
|
|
54
|
+
{item.title}
|
|
55
|
+
</Primitive.TOCItem>
|
|
56
|
+
);
|
|
57
|
+
}
|