@veluai/velu 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cli.js +11 -0
- package/package.json +52 -0
- package/runtime/velu-ui/base.css +311 -0
- package/runtime/velu-ui/components/Accordion.jsx +64 -0
- package/runtime/velu-ui/components/ApiClient.jsx +121 -0
- package/runtime/velu-ui/components/ApiField.jsx +87 -0
- package/runtime/velu-ui/components/ApiPath.jsx +63 -0
- package/runtime/velu-ui/components/ApiSidebar.jsx +122 -0
- package/runtime/velu-ui/components/AskBar.jsx +71 -0
- package/runtime/velu-ui/components/Callout.jsx +114 -0
- package/runtime/velu-ui/components/Card.jsx +131 -0
- package/runtime/velu-ui/components/Chatbot.jsx +596 -0
- package/runtime/velu-ui/components/CodeBlock.jsx +375 -0
- package/runtime/velu-ui/components/Columns.jsx +56 -0
- package/runtime/velu-ui/components/Field.jsx +81 -0
- package/runtime/velu-ui/components/Image.jsx +163 -0
- package/runtime/velu-ui/components/MethodBadge.jsx +31 -0
- package/runtime/velu-ui/components/NavSelect.jsx +108 -0
- package/runtime/velu-ui/components/PageFeedback.jsx +219 -0
- package/runtime/velu-ui/components/PageFooter.jsx +213 -0
- package/runtime/velu-ui/components/PageHeader.jsx +414 -0
- package/runtime/velu-ui/components/PageNav.jsx +77 -0
- package/runtime/velu-ui/components/PoweredBy.jsx +51 -0
- package/runtime/velu-ui/components/Prompt.jsx +115 -0
- package/runtime/velu-ui/components/Search.jsx +366 -0
- package/runtime/velu-ui/components/Sidebar.jsx +191 -0
- package/runtime/velu-ui/components/Steps.jsx +65 -0
- package/runtime/velu-ui/components/ThemeToggle.jsx +48 -0
- package/runtime/velu-ui/components/Toc.jsx +537 -0
- package/runtime/velu-ui/components/TocBar.jsx +195 -0
- package/runtime/velu-ui/components/Tree.jsx +87 -0
- package/runtime/velu-ui/components/TryItBar.jsx +90 -0
- package/runtime/velu-ui/components/accordion.css +92 -0
- package/runtime/velu-ui/components/api.css +479 -0
- package/runtime/velu-ui/components/ask-bar.css +94 -0
- package/runtime/velu-ui/components/card.css +105 -0
- package/runtime/velu-ui/components/chatbot.css +617 -0
- package/runtime/velu-ui/components/code-block.css +263 -0
- package/runtime/velu-ui/components/docs-layout.css +775 -0
- package/runtime/velu-ui/components/field.css +82 -0
- package/runtime/velu-ui/components/image.css +237 -0
- package/runtime/velu-ui/components/nav-select.css +157 -0
- package/runtime/velu-ui/components/page-feedback.css +241 -0
- package/runtime/velu-ui/components/page-footer.css +130 -0
- package/runtime/velu-ui/components/page-header.css +520 -0
- package/runtime/velu-ui/components/page-nav.css +50 -0
- package/runtime/velu-ui/components/powered-by.css +66 -0
- package/runtime/velu-ui/components/prompt.css +99 -0
- package/runtime/velu-ui/components/search.css +307 -0
- package/runtime/velu-ui/components/sidebar.css +144 -0
- package/runtime/velu-ui/components/steps.css +77 -0
- package/runtime/velu-ui/components/theme-toggle.css +70 -0
- package/runtime/velu-ui/components/toc-bar.css +234 -0
- package/runtime/velu-ui/components/tree.css +49 -0
- package/runtime/velu-ui/index.js +45 -0
- package/runtime/velu-ui/lib/copyText.js +64 -0
- package/runtime/velu-ui/lib/lang-icons.jsx +156 -0
- package/runtime/velu-ui/lib/prism-langs.js +957 -0
- package/runtime/velu-ui/lib/prism-loader.js +74 -0
- package/runtime/velu-ui/lib/resolveIcon.jsx +29 -0
- package/runtime/velu-ui/lib/scrollIntoNearestView.js +66 -0
- package/runtime/velu-ui/mdx-components.jsx +85 -0
- package/runtime/velu-ui/primitives/Cluster.jsx +49 -0
- package/runtime/velu-ui/primitives/Stack.jsx +63 -0
- package/runtime/velu-ui/primitives/Switcher.jsx +57 -0
- package/runtime/velu-ui/primitives/stack.css +3 -0
- package/runtime/velu-ui/primitives/switcher.css +25 -0
- package/runtime/velu-ui/styles.css +43 -0
- package/runtime/velu-ui/tokens.css +4 -0
- package/schema/velu.schema.json +167 -0
- package/src/navigation.js +434 -0
- package/src/runtime/App.jsx +1473 -0
- package/src/runtime/client-entry.jsx +22 -0
- package/src/runtime/server-entry.jsx +16 -0
- package/src/template.html +48 -0
- package/templates/starter/ai-tools/claude-code.mdx +26 -0
- package/templates/starter/ai-tools/cursor.mdx +17 -0
- package/templates/starter/api-reference/endpoint/create.mdx +24 -0
- package/templates/starter/api-reference/endpoint/get.mdx +27 -0
- package/templates/starter/api-reference/introduction.mdx +28 -0
- package/templates/starter/development.mdx +19 -0
- package/templates/starter/essentials/code.mdx +28 -0
- package/templates/starter/essentials/images.mdx +29 -0
- package/templates/starter/essentials/markdown.mdx +25 -0
- package/templates/starter/essentials/navigation.mdx +39 -0
- package/templates/starter/essentials/settings.mdx +30 -0
- package/templates/starter/favicon.svg +6 -0
- package/templates/starter/index.mdx +31 -0
- package/templates/starter/quickstart.mdx +31 -0
- package/templates/starter/velu.json +33 -0
|
@@ -0,0 +1,414 @@
|
|
|
1
|
+
import React from 'react';
|
|
2
|
+
import { MoreVertical, Menu, ChevronRight } from 'lucide-react';
|
|
3
|
+
import resolveIcon from '../lib/resolveIcon.jsx';
|
|
4
|
+
import Stack from '../primitives/Stack.jsx';
|
|
5
|
+
import Cluster from '../primitives/Cluster.jsx';
|
|
6
|
+
|
|
7
|
+
/**
|
|
8
|
+
* PageHeader — top of the docs site.
|
|
9
|
+
*
|
|
10
|
+
* <PageHeader
|
|
11
|
+
* linkComponent={RouterLink}
|
|
12
|
+
* brand={{ label: 'Velu', href: '/' }}
|
|
13
|
+
* center={<Search />} // search + adjacent bits
|
|
14
|
+
* actions={[
|
|
15
|
+
* { label: 'Book Demo', kind: 'primary', href: '/demo' },
|
|
16
|
+
* ]}
|
|
17
|
+
* activeTab="/"
|
|
18
|
+
* tabs={[
|
|
19
|
+
* { label: 'Home', icon: 'home', href: '/' },
|
|
20
|
+
* { label: 'Docs', icon: 'book', href: '/docs', external: true },
|
|
21
|
+
* { label: 'Blog', icon: 'rss', href: '/blog' },
|
|
22
|
+
* ]}
|
|
23
|
+
* />
|
|
24
|
+
*
|
|
25
|
+
* Layout: a top row (3-column grid — brand | center | actions) plus an
|
|
26
|
+
* optional tabs row below. All slots are fully data-driven; pass any
|
|
27
|
+
* number of actions and any number of tabs.
|
|
28
|
+
*
|
|
29
|
+
* @typedef {Object} HeaderTab
|
|
30
|
+
* @property {string} label
|
|
31
|
+
* @property {string|React.ReactNode} [icon] lucide id or node
|
|
32
|
+
* @property {string} [href]
|
|
33
|
+
* @property {boolean} [active] explicit override
|
|
34
|
+
* @property {boolean} [external] renders an outlink chip
|
|
35
|
+
*
|
|
36
|
+
* @typedef {Object} HeaderAction
|
|
37
|
+
* @property {string} label
|
|
38
|
+
* @property {string|React.ReactNode} [icon]
|
|
39
|
+
* @property {'primary'|'outlined'} [kind] default 'outlined'
|
|
40
|
+
* @property {string} [href]
|
|
41
|
+
* @property {() => void} [onClick]
|
|
42
|
+
* @property {boolean} [external]
|
|
43
|
+
*
|
|
44
|
+
* @param {{ brand?: { label?: string, href?: string },
|
|
45
|
+
* center?: React.ReactNode, actions?: HeaderAction[],
|
|
46
|
+
* tabs?: HeaderTab[], activeTab?: string,
|
|
47
|
+
* linkComponent?: React.ElementType, className?: string }} props
|
|
48
|
+
*/
|
|
49
|
+
|
|
50
|
+
/* Velu brand mark. Color: --accent-color via the wrapping wordmark
|
|
51
|
+
span; the path uses currentColor. Exported so consumers (e.g. the
|
|
52
|
+
mobile nav drawer) can render the mark alongside its own chrome. */
|
|
53
|
+
export function VeluMark() {
|
|
54
|
+
return (
|
|
55
|
+
<svg
|
|
56
|
+
className="velu-header__mark"
|
|
57
|
+
viewBox="0 0 32 24"
|
|
58
|
+
fill="currentColor"
|
|
59
|
+
aria-hidden="true"
|
|
60
|
+
>
|
|
61
|
+
<path
|
|
62
|
+
fillRule="evenodd"
|
|
63
|
+
clipRule="evenodd"
|
|
64
|
+
d="M29.6564 14.1534C29.5739 14.5616 29.3507 14.9288 29.0248 15.1926C28.699 15.4565 28.2907 15.6007 27.8694 15.6006H21.3702C20.5341 15.6006 19.8051 16.1627 19.6031 16.9638L18.1671 22.6368C18.0685 23.0263 17.8409 23.372 17.5205 23.619C17.2002 23.866 16.8054 24.0001 16.399 24H10.4378C10.1609 24.0001 9.88759 23.9378 9.63868 23.8179C9.38976 23.6979 9.1718 23.5235 9.00135 23.3079C8.8309 23.0923 8.71245 22.8412 8.65499 22.5736C8.59754 22.306 8.6026 22.029 8.66978 21.7636L10.1888 15.7636C10.2874 15.3743 10.5148 15.0287 10.835 14.7817C11.1551 14.5347 11.5496 14.4005 11.9559 14.4004H18.3931C19.2621 14.4004 20.0101 13.7949 20.1801 12.9532L22.3882 2.04774C22.4705 1.63945 22.6936 1.27198 23.0195 1.00793C23.3453 0.74388 23.7538 0.599578 24.1752 0.599605H30.1774C30.4471 0.599529 30.7134 0.658587 30.9572 0.772515C31.201 0.886444 31.4161 1.0524 31.5871 1.25842C31.758 1.46443 31.8806 1.70537 31.9458 1.96383C32.0111 2.2223 32.0175 2.49185 31.9645 2.75305L29.6564 14.1534ZM9.61081 13.5538C9.52825 13.962 9.30507 14.3292 8.97924 14.593C8.65341 14.857 8.24508 15.0011 7.82375 15.001H1.82257C1.55289 15.0011 1.28656 14.942 1.04279 14.8281C0.79902 14.7141 0.583892 14.5482 0.412928 14.3422C0.241965 14.1362 0.11943 13.8952 0.0541639 13.6368C-0.0111017 13.3783 -0.0174699 13.1087 0.0355186 12.8475L2.34359 1.44715C2.42614 1.03904 2.64933 0.671798 2.97516 0.407944C3.30099 0.144089 3.70932 -7.24082e-05 4.13064 7.25899e-08H10.1318C10.4015 -7.55792e-05 10.6678 0.0589818 10.9116 0.172911C11.1554 0.286839 11.3705 0.453799 11.5415 0.659813C11.7124 0.864828 11.835 1.10576 11.9002 1.36423C11.9655 1.62269 11.9719 1.89225 11.9189 2.15344L9.61081 13.5538Z"
|
|
65
|
+
/>
|
|
66
|
+
</svg>
|
|
67
|
+
);
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
function ActionButton({ action, Link }) {
|
|
71
|
+
const { label, icon, kind = 'outlined', href, onClick, external } = action;
|
|
72
|
+
const cls = `velu-header__action velu-header__action--${kind}`;
|
|
73
|
+
const content = (
|
|
74
|
+
<>
|
|
75
|
+
{icon && (
|
|
76
|
+
<span className="velu-header__action-icon" aria-hidden="true">
|
|
77
|
+
{resolveIcon(icon, { size: '1em' })}
|
|
78
|
+
</span>
|
|
79
|
+
)}
|
|
80
|
+
<span>{label}</span>
|
|
81
|
+
</>
|
|
82
|
+
);
|
|
83
|
+
if (href) {
|
|
84
|
+
const Tag = external ? 'a' : Link;
|
|
85
|
+
const extraProps = external
|
|
86
|
+
? { target: '_blank', rel: 'noreferrer' }
|
|
87
|
+
: {};
|
|
88
|
+
return (
|
|
89
|
+
<Tag className={cls} href={href} {...extraProps}>
|
|
90
|
+
{content}
|
|
91
|
+
</Tag>
|
|
92
|
+
);
|
|
93
|
+
}
|
|
94
|
+
return (
|
|
95
|
+
<button type="button" className={cls} onClick={onClick}>
|
|
96
|
+
{content}
|
|
97
|
+
</button>
|
|
98
|
+
);
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
function HeaderTab({ tab, isActive, Link }) {
|
|
102
|
+
const { label, icon, href = '#', external } = tab;
|
|
103
|
+
const cls = `velu-header__tab${isActive ? ' velu-header__tab--active' : ''}`;
|
|
104
|
+
const Tag = external ? 'a' : Link;
|
|
105
|
+
const extraProps = external
|
|
106
|
+
? { target: '_blank', rel: 'noreferrer' }
|
|
107
|
+
: {};
|
|
108
|
+
return (
|
|
109
|
+
<Tag
|
|
110
|
+
className={cls}
|
|
111
|
+
href={href}
|
|
112
|
+
aria-current={isActive ? 'page' : undefined}
|
|
113
|
+
{...extraProps}
|
|
114
|
+
>
|
|
115
|
+
{icon && (
|
|
116
|
+
<span className="velu-header__tab-icon" aria-hidden="true">
|
|
117
|
+
{resolveIcon(icon, { size: '1.5em' })}
|
|
118
|
+
</span>
|
|
119
|
+
)}
|
|
120
|
+
<span>{label}</span>
|
|
121
|
+
{external && (
|
|
122
|
+
<span className="velu-header__tab-external" aria-hidden="true">
|
|
123
|
+
{resolveIcon('external-link', { size: '1em' })}
|
|
124
|
+
</span>
|
|
125
|
+
)}
|
|
126
|
+
</Tag>
|
|
127
|
+
);
|
|
128
|
+
}
|
|
129
|
+
|
|
130
|
+
/* Narrow-width overflow menu — the same `actions` items rendered as a
|
|
131
|
+
simple vertical dropdown under a triple-dot button. CSS in
|
|
132
|
+
page-header.css hides this component at wide widths and the inline
|
|
133
|
+
action list at narrow widths so only one is ever visible.
|
|
134
|
+
Click-outside + Escape close the menu. */
|
|
135
|
+
function KebabMenu({ actions, Link }) {
|
|
136
|
+
const [open, setOpen] = React.useState(false);
|
|
137
|
+
const rootRef = React.useRef(null);
|
|
138
|
+
|
|
139
|
+
React.useEffect(() => {
|
|
140
|
+
if (!open) return;
|
|
141
|
+
const onDocClick = (e) => {
|
|
142
|
+
if (!rootRef.current?.contains(e.target)) setOpen(false);
|
|
143
|
+
};
|
|
144
|
+
const onKey = (e) => {
|
|
145
|
+
if (e.key === 'Escape') setOpen(false);
|
|
146
|
+
};
|
|
147
|
+
document.addEventListener('mousedown', onDocClick);
|
|
148
|
+
document.addEventListener('keydown', onKey);
|
|
149
|
+
return () => {
|
|
150
|
+
document.removeEventListener('mousedown', onDocClick);
|
|
151
|
+
document.removeEventListener('keydown', onKey);
|
|
152
|
+
};
|
|
153
|
+
}, [open]);
|
|
154
|
+
|
|
155
|
+
return (
|
|
156
|
+
<div
|
|
157
|
+
ref={rootRef}
|
|
158
|
+
className="velu-header__kebab"
|
|
159
|
+
data-open={open ? 'true' : 'false'}
|
|
160
|
+
>
|
|
161
|
+
<button
|
|
162
|
+
type="button"
|
|
163
|
+
className="velu-header__kebab-toggle"
|
|
164
|
+
aria-label="More actions"
|
|
165
|
+
aria-haspopup="menu"
|
|
166
|
+
aria-expanded={open}
|
|
167
|
+
onClick={() => setOpen((v) => !v)}
|
|
168
|
+
>
|
|
169
|
+
<MoreVertical aria-hidden="true" focusable="false" />
|
|
170
|
+
</button>
|
|
171
|
+
<ul className="velu-header__kebab-menu" role="menu" aria-hidden={!open}>
|
|
172
|
+
{actions.map((a, i) => {
|
|
173
|
+
const { label, icon, href, onClick, external } = a;
|
|
174
|
+
const content = (
|
|
175
|
+
<>
|
|
176
|
+
{icon && (
|
|
177
|
+
<span className="velu-header__kebab-icon" aria-hidden="true">
|
|
178
|
+
{resolveIcon(icon, { size: '1em' })}
|
|
179
|
+
</span>
|
|
180
|
+
)}
|
|
181
|
+
<span>{label}</span>
|
|
182
|
+
</>
|
|
183
|
+
);
|
|
184
|
+
const close = () => setOpen(false);
|
|
185
|
+
if (href) {
|
|
186
|
+
const Tag = external ? 'a' : Link;
|
|
187
|
+
const extra = external
|
|
188
|
+
? { target: '_blank', rel: 'noreferrer' }
|
|
189
|
+
: {};
|
|
190
|
+
return (
|
|
191
|
+
<li key={i} role="none">
|
|
192
|
+
<Tag
|
|
193
|
+
role="menuitem"
|
|
194
|
+
className="velu-header__kebab-item"
|
|
195
|
+
href={href}
|
|
196
|
+
onClick={close}
|
|
197
|
+
tabIndex={open ? 0 : -1}
|
|
198
|
+
{...extra}
|
|
199
|
+
>
|
|
200
|
+
{content}
|
|
201
|
+
</Tag>
|
|
202
|
+
</li>
|
|
203
|
+
);
|
|
204
|
+
}
|
|
205
|
+
return (
|
|
206
|
+
<li key={i} role="none">
|
|
207
|
+
<button
|
|
208
|
+
type="button"
|
|
209
|
+
role="menuitem"
|
|
210
|
+
className="velu-header__kebab-item"
|
|
211
|
+
onClick={() => {
|
|
212
|
+
onClick?.();
|
|
213
|
+
close();
|
|
214
|
+
}}
|
|
215
|
+
tabIndex={open ? 0 : -1}
|
|
216
|
+
>
|
|
217
|
+
{content}
|
|
218
|
+
</button>
|
|
219
|
+
</li>
|
|
220
|
+
);
|
|
221
|
+
})}
|
|
222
|
+
</ul>
|
|
223
|
+
</div>
|
|
224
|
+
);
|
|
225
|
+
}
|
|
226
|
+
|
|
227
|
+
export default function PageHeader({
|
|
228
|
+
brand,
|
|
229
|
+
brandTrailing,
|
|
230
|
+
center,
|
|
231
|
+
actions = [],
|
|
232
|
+
trailing,
|
|
233
|
+
tabs = [],
|
|
234
|
+
tabsTrailing,
|
|
235
|
+
activeTab,
|
|
236
|
+
breadcrumb,
|
|
237
|
+
onMenuClick,
|
|
238
|
+
linkComponent = 'a',
|
|
239
|
+
className = '',
|
|
240
|
+
...rest
|
|
241
|
+
}) {
|
|
242
|
+
const Link = linkComponent;
|
|
243
|
+
const brandLabel = brand?.label ?? 'Velu';
|
|
244
|
+
const brandHref = brand?.href;
|
|
245
|
+
|
|
246
|
+
// Track whether the page has been scrolled so the header can flip
|
|
247
|
+
// from solid to translucent / frosted. Edge-triggered (only updates
|
|
248
|
+
// when crossing scrollY=0) so React doesn't re-render the header on
|
|
249
|
+
// every scroll event.
|
|
250
|
+
const [scrolled, setScrolled] = React.useState(false);
|
|
251
|
+
React.useEffect(() => {
|
|
252
|
+
const onScroll = () => {
|
|
253
|
+
const next = window.scrollY > 0;
|
|
254
|
+
setScrolled((prev) => (prev === next ? prev : next));
|
|
255
|
+
};
|
|
256
|
+
onScroll();
|
|
257
|
+
window.addEventListener('scroll', onScroll, { passive: true });
|
|
258
|
+
return () => window.removeEventListener('scroll', onScroll);
|
|
259
|
+
}, []);
|
|
260
|
+
|
|
261
|
+
const brandBlock = (
|
|
262
|
+
<Cluster space="var(--s-3)" align="center" className="velu-header__brand">
|
|
263
|
+
<VeluMark />
|
|
264
|
+
<span className="velu-header__wordmark">{brandLabel}</span>
|
|
265
|
+
</Cluster>
|
|
266
|
+
);
|
|
267
|
+
|
|
268
|
+
return (
|
|
269
|
+
<Stack
|
|
270
|
+
as="header"
|
|
271
|
+
space="var(--s0)"
|
|
272
|
+
className={`velu-header${scrolled ? ' velu-header--scrolled' : ''} ${className}`.trim()}
|
|
273
|
+
{...rest}
|
|
274
|
+
>
|
|
275
|
+
{/* Top row — 3-column grid: brand | center | actions. */}
|
|
276
|
+
<div className="velu-header__top">
|
|
277
|
+
<Cluster
|
|
278
|
+
space="var(--s-1)"
|
|
279
|
+
align="center"
|
|
280
|
+
className="velu-header__col velu-header__col--brand"
|
|
281
|
+
>
|
|
282
|
+
{brandHref ? (
|
|
283
|
+
<Link href={brandHref} className="velu-header__brand-link">
|
|
284
|
+
{brandBlock}
|
|
285
|
+
</Link>
|
|
286
|
+
) : (
|
|
287
|
+
brandBlock
|
|
288
|
+
)}
|
|
289
|
+
{/* Slot rendered right after the brand (e.g. version pill). */}
|
|
290
|
+
{brandTrailing}
|
|
291
|
+
</Cluster>
|
|
292
|
+
|
|
293
|
+
{center && (
|
|
294
|
+
<div className="velu-header__col velu-header__col--center">
|
|
295
|
+
{center}
|
|
296
|
+
</div>
|
|
297
|
+
)}
|
|
298
|
+
|
|
299
|
+
{(actions.length > 0 || trailing) && (
|
|
300
|
+
<Cluster
|
|
301
|
+
space="var(--s-2)"
|
|
302
|
+
align="center"
|
|
303
|
+
className="velu-header__col velu-header__col--actions"
|
|
304
|
+
>
|
|
305
|
+
{/* Inline action buttons — hidden at narrow widths (where
|
|
306
|
+
the kebab takes over) via @container query in
|
|
307
|
+
page-header.css. */}
|
|
308
|
+
{actions.length > 0 && (
|
|
309
|
+
<div className="velu-header__actions-list">
|
|
310
|
+
{actions.map((a, i) => (
|
|
311
|
+
<ActionButton key={i} action={a} Link={Link} />
|
|
312
|
+
))}
|
|
313
|
+
</div>
|
|
314
|
+
)}
|
|
315
|
+
{trailing}
|
|
316
|
+
{/* Kebab — only displayed at narrow widths. The dropdown
|
|
317
|
+
surfaces the same `actions` items as the inline list,
|
|
318
|
+
so the data source stays single. */}
|
|
319
|
+
{actions.length > 0 && (
|
|
320
|
+
<KebabMenu actions={actions} Link={Link} />
|
|
321
|
+
)}
|
|
322
|
+
</Cluster>
|
|
323
|
+
)}
|
|
324
|
+
</div>
|
|
325
|
+
|
|
326
|
+
{/* Tabs row — at wide widths shows the `tabs` cluster; at mobile
|
|
327
|
+
the tabs are CSS-hidden and the `breadcrumb` (if provided)
|
|
328
|
+
takes their place. Burger stays at the trailing edge via
|
|
329
|
+
margin-inline-start: auto on the burger button itself, so
|
|
330
|
+
its position is unaffected by the breadcrumb's length. */}
|
|
331
|
+
{(tabs.length > 0 ||
|
|
332
|
+
(breadcrumb && breadcrumb.length > 0) ||
|
|
333
|
+
tabsTrailing ||
|
|
334
|
+
onMenuClick) && (
|
|
335
|
+
<Cluster
|
|
336
|
+
space="var(--s0)"
|
|
337
|
+
align="center"
|
|
338
|
+
className="velu-header__tabs"
|
|
339
|
+
>
|
|
340
|
+
{tabs.map((tab, i) => {
|
|
341
|
+
const isActive =
|
|
342
|
+
tab.active || (tab.href != null && tab.href === activeTab);
|
|
343
|
+
return (
|
|
344
|
+
<HeaderTab
|
|
345
|
+
key={i}
|
|
346
|
+
tab={tab}
|
|
347
|
+
isActive={isActive}
|
|
348
|
+
Link={Link}
|
|
349
|
+
/>
|
|
350
|
+
);
|
|
351
|
+
})}
|
|
352
|
+
{/* Single-line breadcrumb. Hidden at wide widths (see
|
|
353
|
+
page-header.css). When `onMenuClick` is provided the
|
|
354
|
+
whole strip is a button that opens the nav drawer —
|
|
355
|
+
individual segment links are deliberately collapsed
|
|
356
|
+
into one tap target so the chevron + segments read as
|
|
357
|
+
"open menu" rather than separate links. */}
|
|
358
|
+
{breadcrumb && breadcrumb.length > 0 && (
|
|
359
|
+
<button
|
|
360
|
+
type="button"
|
|
361
|
+
className="velu-header__crumbs"
|
|
362
|
+
onClick={onMenuClick}
|
|
363
|
+
aria-label="Open navigation menu"
|
|
364
|
+
>
|
|
365
|
+
{breadcrumb.map((c, i) => {
|
|
366
|
+
const isLast = i === breadcrumb.length - 1;
|
|
367
|
+
return (
|
|
368
|
+
<React.Fragment key={i}>
|
|
369
|
+
{i > 0 && (
|
|
370
|
+
<ChevronRight
|
|
371
|
+
className="velu-header__crumb-sep"
|
|
372
|
+
aria-hidden="true"
|
|
373
|
+
focusable="false"
|
|
374
|
+
/>
|
|
375
|
+
)}
|
|
376
|
+
<span
|
|
377
|
+
className={`velu-header__crumb${
|
|
378
|
+
isLast ? ' velu-header__crumb--current' : ''
|
|
379
|
+
}`}
|
|
380
|
+
>
|
|
381
|
+
{c.label}
|
|
382
|
+
</span>
|
|
383
|
+
</React.Fragment>
|
|
384
|
+
);
|
|
385
|
+
})}
|
|
386
|
+
</button>
|
|
387
|
+
)}
|
|
388
|
+
{/* Trailing slot at the bottom-right of the header (right end
|
|
389
|
+
of the tabs row) — e.g. the language switcher. Pushed
|
|
390
|
+
right via margin-auto; hidden on mobile (folds into the
|
|
391
|
+
drawer) via page-header.css. */}
|
|
392
|
+
{tabsTrailing && (
|
|
393
|
+
<div className="velu-header__tabs-trailing">{tabsTrailing}</div>
|
|
394
|
+
)}
|
|
395
|
+
{/* Mobile-only burger — sits at the trailing edge of the tabs
|
|
396
|
+
row via CSS (margin-inline-start: auto in page-header.css).
|
|
397
|
+
Hidden at wider widths; visible at < 640px. Fires the
|
|
398
|
+
consumer's `onMenuClick` so the parent decides what mobile
|
|
399
|
+
navigation to surface (e.g. a slide-down menu). */}
|
|
400
|
+
{onMenuClick && (
|
|
401
|
+
<button
|
|
402
|
+
type="button"
|
|
403
|
+
className="velu-header__menu"
|
|
404
|
+
aria-label="Open navigation menu"
|
|
405
|
+
onClick={onMenuClick}
|
|
406
|
+
>
|
|
407
|
+
<Menu aria-hidden="true" focusable="false" />
|
|
408
|
+
</button>
|
|
409
|
+
)}
|
|
410
|
+
</Cluster>
|
|
411
|
+
)}
|
|
412
|
+
</Stack>
|
|
413
|
+
);
|
|
414
|
+
}
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
import React from 'react';
|
|
2
|
+
import resolveIcon from '../lib/resolveIcon.jsx';
|
|
3
|
+
import Cluster from '../primitives/Cluster.jsx';
|
|
4
|
+
import Switcher from '../primitives/Switcher.jsx';
|
|
5
|
+
|
|
6
|
+
/**
|
|
7
|
+
* PageNav — previous / next page navigation for the foot of a docs
|
|
8
|
+
* page. Two cards: the previous page (content flush to the inline
|
|
9
|
+
* start, a "‹ Previous" label) and the next page (flush to the inline
|
|
10
|
+
* end, "Next ›").
|
|
11
|
+
*
|
|
12
|
+
* <PageNav
|
|
13
|
+
* linkComponent={RouterLink}
|
|
14
|
+
* prev={{ label: 'docs.json schema reference', href: '/schema' }}
|
|
15
|
+
* next={{ label: 'Pages', href: '/pages' }}
|
|
16
|
+
* />
|
|
17
|
+
*
|
|
18
|
+
* Either side may be omitted (first / last page) — the present card
|
|
19
|
+
* keeps its half-width slot. Cards sit side by side and stack on narrow
|
|
20
|
+
* widths via <Switcher>. Router-agnostic through `linkComponent`.
|
|
21
|
+
*
|
|
22
|
+
* @typedef {Object} PageRef
|
|
23
|
+
* @property {string} label page title shown on the card
|
|
24
|
+
* @property {string} [href]
|
|
25
|
+
*
|
|
26
|
+
* @param {{ prev?: PageRef, next?: PageRef,
|
|
27
|
+
* linkComponent?: React.ElementType, className?: string }} props
|
|
28
|
+
*/
|
|
29
|
+
|
|
30
|
+
function NavCard({ page, dir, Link }) {
|
|
31
|
+
const isPrev = dir === 'prev';
|
|
32
|
+
return (
|
|
33
|
+
<Link
|
|
34
|
+
className={`velu-pagenav__card velu-pagenav__card--${dir}`}
|
|
35
|
+
href={page.href ?? '#'}
|
|
36
|
+
>
|
|
37
|
+
<span className="velu-pagenav__title">{page.label}</span>
|
|
38
|
+
<Cluster
|
|
39
|
+
space="var(--s-4)"
|
|
40
|
+
align="center"
|
|
41
|
+
className="velu-pagenav__dir"
|
|
42
|
+
>
|
|
43
|
+
{isPrev && resolveIcon('chevron-left', { size: '1em' })}
|
|
44
|
+
<span>{isPrev ? 'Previous' : 'Next'}</span>
|
|
45
|
+
{!isPrev && resolveIcon('chevron-right', { size: '1em' })}
|
|
46
|
+
</Cluster>
|
|
47
|
+
</Link>
|
|
48
|
+
);
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
export default function PageNav({
|
|
52
|
+
prev,
|
|
53
|
+
next,
|
|
54
|
+
linkComponent = 'a',
|
|
55
|
+
className = '',
|
|
56
|
+
...rest
|
|
57
|
+
}) {
|
|
58
|
+
return (
|
|
59
|
+
<Switcher
|
|
60
|
+
space="var(--s0)"
|
|
61
|
+
min="16ch"
|
|
62
|
+
className={`velu-pagenav ${className}`.trim()}
|
|
63
|
+
{...rest}
|
|
64
|
+
>
|
|
65
|
+
{prev ? (
|
|
66
|
+
<NavCard page={prev} dir="prev" Link={linkComponent} />
|
|
67
|
+
) : (
|
|
68
|
+
<div aria-hidden="true" />
|
|
69
|
+
)}
|
|
70
|
+
{next ? (
|
|
71
|
+
<NavCard page={next} dir="next" Link={linkComponent} />
|
|
72
|
+
) : (
|
|
73
|
+
<div aria-hidden="true" />
|
|
74
|
+
)}
|
|
75
|
+
</Switcher>
|
|
76
|
+
);
|
|
77
|
+
}
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
import React from 'react';
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* PoweredBy — "Powered by Velu" badge. Right-aligned, sits above the
|
|
5
|
+
* site footer (or anywhere the consumer drops it). All values are
|
|
6
|
+
* tokens; light/dark via [data-theme] is automatic.
|
|
7
|
+
*
|
|
8
|
+
* @param {{ href?: string, className?: string }} props
|
|
9
|
+
*/
|
|
10
|
+
|
|
11
|
+
/* Velu brand mark — same path as PageHeader's mark, sized for the
|
|
12
|
+
badge via .velu-powered-by__mark CSS. */
|
|
13
|
+
function VeluMark() {
|
|
14
|
+
return (
|
|
15
|
+
<svg
|
|
16
|
+
className="velu-powered-by__mark"
|
|
17
|
+
viewBox="0 0 32 24"
|
|
18
|
+
fill="currentColor"
|
|
19
|
+
aria-hidden="true"
|
|
20
|
+
>
|
|
21
|
+
<path
|
|
22
|
+
fillRule="evenodd"
|
|
23
|
+
clipRule="evenodd"
|
|
24
|
+
d="M29.6564 14.1534C29.5739 14.5616 29.3507 14.9288 29.0248 15.1926C28.699 15.4565 28.2907 15.6007 27.8694 15.6006H21.3702C20.5341 15.6006 19.8051 16.1627 19.6031 16.9638L18.1671 22.6368C18.0685 23.0263 17.8409 23.372 17.5205 23.619C17.2002 23.866 16.8054 24.0001 16.399 24H10.4378C10.1609 24.0001 9.88759 23.9378 9.63868 23.8179C9.38976 23.6979 9.1718 23.5235 9.00135 23.3079C8.8309 23.0923 8.71245 22.8412 8.65499 22.5736C8.59754 22.306 8.6026 22.029 8.66978 21.7636L10.1888 15.7636C10.2874 15.3743 10.5148 15.0287 10.835 14.7817C11.1551 14.5347 11.5496 14.4005 11.9559 14.4004H18.3931C19.2621 14.4004 20.0101 13.7949 20.1801 12.9532L22.3882 2.04774C22.4705 1.63945 22.6936 1.27198 23.0195 1.00793C23.3453 0.74388 23.7538 0.599578 24.1752 0.599605H30.1774C30.4471 0.599529 30.7134 0.658587 30.9572 0.772515C31.201 0.886444 31.4161 1.0524 31.5871 1.25842C31.758 1.46443 31.8806 1.70537 31.9458 1.96383C32.0111 2.2223 32.0175 2.49185 31.9645 2.75305L29.6564 14.1534ZM9.61081 13.5538C9.52825 13.962 9.30507 14.3292 8.97924 14.593C8.65341 14.857 8.24508 15.0011 7.82375 15.001H1.82257C1.55289 15.0011 1.28656 14.942 1.04279 14.8281C0.79902 14.7141 0.583892 14.5482 0.412928 14.3422C0.241965 14.1362 0.11943 13.8952 0.0541639 13.6368C-0.0111017 13.3783 -0.0174699 13.1087 0.0355186 12.8475L2.34359 1.44715C2.42614 1.03904 2.64933 0.671798 2.97516 0.407944C3.30099 0.144089 3.70932 -7.24082e-05 4.13064 7.25899e-08H10.1318C10.4015 -7.55792e-05 10.6678 0.0589818 10.9116 0.172911C11.1554 0.286839 11.3705 0.453799 11.5415 0.659813C11.7124 0.864828 11.835 1.10576 11.9002 1.36423C11.9655 1.62269 11.9719 1.89225 11.9189 2.15344L9.61081 13.5538Z"
|
|
25
|
+
/>
|
|
26
|
+
</svg>
|
|
27
|
+
);
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
export default function PoweredBy({
|
|
31
|
+
href = 'https://veludocs.com',
|
|
32
|
+
className = '',
|
|
33
|
+
...rest
|
|
34
|
+
}) {
|
|
35
|
+
return (
|
|
36
|
+
<div className={`velu-powered-by ${className}`.trim()} {...rest}>
|
|
37
|
+
<a
|
|
38
|
+
className="velu-powered-by__link"
|
|
39
|
+
href={href}
|
|
40
|
+
target="_blank"
|
|
41
|
+
rel="noreferrer"
|
|
42
|
+
>
|
|
43
|
+
<span className="velu-powered-by__label">Powered by</span>
|
|
44
|
+
<span className="velu-powered-by__brand">
|
|
45
|
+
<VeluMark />
|
|
46
|
+
<span className="velu-powered-by__wordmark">Velu</span>
|
|
47
|
+
</span>
|
|
48
|
+
</a>
|
|
49
|
+
</div>
|
|
50
|
+
);
|
|
51
|
+
}
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
import React, { useState } from 'react';
|
|
2
|
+
import resolveIcon from '../lib/resolveIcon.jsx';
|
|
3
|
+
import Cluster from '../primitives/Cluster.jsx';
|
|
4
|
+
import copyText from '../lib/copyText.js';
|
|
5
|
+
|
|
6
|
+
// Cursor brand glyph (https://cursor.com). Inline SVG so it scales with
|
|
7
|
+
// font-size via currentColor — no extra dependency.
|
|
8
|
+
function CursorIcon({ size = '1em' }) {
|
|
9
|
+
return (
|
|
10
|
+
<svg
|
|
11
|
+
viewBox="0 0 466.73 532.09"
|
|
12
|
+
width={size}
|
|
13
|
+
height={size}
|
|
14
|
+
fill="currentColor"
|
|
15
|
+
aria-hidden="true"
|
|
16
|
+
>
|
|
17
|
+
<path d="M457.43,125.94L244.42,2.96c-6.84-3.95-15.28-3.95-22.12,0L9.3,125.94c-5.75,3.32-9.3,9.46-9.3,16.11v247.99c0,6.65,3.55,12.79,9.3,16.11l213.01,122.98c6.84,3.95,15.28,3.95,22.12,0l213.01-122.98c5.75-3.32,9.3-9.46,9.3-16.11v-247.99c0-6.65-3.55-12.79-9.3-16.11h-.01ZM444.05,151.99l-205.63,356.16c-1.39,2.4-5.06,1.42-5.06-1.36v-233.21c0-4.66-2.49-8.97-6.53-11.31L24.87,145.67c-2.4-1.39-1.42-5.06,1.36-5.06h411.26c5.84,0,9.49,6.33,6.57,11.39h-.01Z" />
|
|
18
|
+
</svg>
|
|
19
|
+
);
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
/**
|
|
23
|
+
* Prompt — display an AI prompt with a title + a truncated preview of
|
|
24
|
+
* the body, plus a "Copy Prompt" button that writes the FULL prompt
|
|
25
|
+
* (not the truncated preview) to the clipboard.
|
|
26
|
+
*
|
|
27
|
+
* <Prompt title="Generate clear, concise documentation.">
|
|
28
|
+
* {`You are a **technical writing assistant**. Write documentation
|
|
29
|
+
* that is clear, accurate, and concise.
|
|
30
|
+
* - Use second-person voice
|
|
31
|
+
* - Avoid jargon
|
|
32
|
+
* - …more lines that get truncated by line-clamp`}
|
|
33
|
+
* </Prompt>
|
|
34
|
+
*
|
|
35
|
+
* - `title` short headline above the prompt body
|
|
36
|
+
* - `lines` number of body lines to show before the ellipsis
|
|
37
|
+
* (default 3) — driven by CSS `-webkit-line-clamp`
|
|
38
|
+
* - `children` full prompt text (string, multi-line OK)
|
|
39
|
+
*
|
|
40
|
+
* The truncated preview keeps the monospace style of the source code
|
|
41
|
+
* (so multi-line prompts read like the file you'd paste them from);
|
|
42
|
+
* line clamping adds the trailing "…" automatically.
|
|
43
|
+
*/
|
|
44
|
+
|
|
45
|
+
export default function Prompt({
|
|
46
|
+
title,
|
|
47
|
+
lines = 3,
|
|
48
|
+
openInCursor = false,
|
|
49
|
+
children,
|
|
50
|
+
className = '',
|
|
51
|
+
...rest
|
|
52
|
+
}) {
|
|
53
|
+
const [copied, setCopied] = useState(false);
|
|
54
|
+
const promptText = typeof children === 'string' ? children : '';
|
|
55
|
+
const cursorUrl = `https://cursor.com/link/prompt?text=${encodeURIComponent(
|
|
56
|
+
promptText,
|
|
57
|
+
)}`;
|
|
58
|
+
|
|
59
|
+
function copy() {
|
|
60
|
+
copyText(promptText).then(
|
|
61
|
+
() => {
|
|
62
|
+
setCopied(true);
|
|
63
|
+
setTimeout(() => setCopied(false), 1500);
|
|
64
|
+
},
|
|
65
|
+
() => {
|
|
66
|
+
/* user denied / no focus / no clipboard — silent no-op */
|
|
67
|
+
},
|
|
68
|
+
);
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
return (
|
|
72
|
+
<div className={`velu-prompt ${className}`.trim()} {...rest}>
|
|
73
|
+
{title != null && (
|
|
74
|
+
<div className="velu-prompt__title">{title}</div>
|
|
75
|
+
)}
|
|
76
|
+
<div
|
|
77
|
+
className="velu-prompt__body"
|
|
78
|
+
style={{ WebkitLineClamp: lines }}
|
|
79
|
+
>
|
|
80
|
+
{children}
|
|
81
|
+
</div>
|
|
82
|
+
<Cluster
|
|
83
|
+
space="var(--s-1)"
|
|
84
|
+
justify="flex-end"
|
|
85
|
+
className="velu-prompt__actions"
|
|
86
|
+
>
|
|
87
|
+
{openInCursor && (
|
|
88
|
+
<a
|
|
89
|
+
href={cursorUrl}
|
|
90
|
+
target="_blank"
|
|
91
|
+
rel="noopener noreferrer"
|
|
92
|
+
className="velu-prompt__open-cursor"
|
|
93
|
+
aria-label="Open prompt in Cursor"
|
|
94
|
+
>
|
|
95
|
+
<span className="velu-prompt__copy-icon" aria-hidden="true">
|
|
96
|
+
<CursorIcon />
|
|
97
|
+
</span>
|
|
98
|
+
Open in Cursor
|
|
99
|
+
</a>
|
|
100
|
+
)}
|
|
101
|
+
<button
|
|
102
|
+
type="button"
|
|
103
|
+
onClick={copy}
|
|
104
|
+
className="velu-prompt__copy"
|
|
105
|
+
aria-label={copied ? 'Copied' : 'Copy prompt'}
|
|
106
|
+
>
|
|
107
|
+
<span className="velu-prompt__copy-icon" aria-hidden="true">
|
|
108
|
+
{resolveIcon(copied ? 'check' : 'copy', { size: '1em' })}
|
|
109
|
+
</span>
|
|
110
|
+
{copied ? 'Copied' : 'Copy Prompt'}
|
|
111
|
+
</button>
|
|
112
|
+
</Cluster>
|
|
113
|
+
</div>
|
|
114
|
+
);
|
|
115
|
+
}
|