@veluai/velu 0.2.13 → 0.2.15

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.
Files changed (109) hide show
  1. package/README.md +80 -80
  2. package/dist/cli.js +37 -37
  3. package/package.json +64 -64
  4. package/runtime/velu-ui/base.css +320 -320
  5. package/runtime/velu-ui/components/Accordion.jsx +64 -64
  6. package/runtime/velu-ui/components/ApiClient.jsx +207 -207
  7. package/runtime/velu-ui/components/ApiField.jsx +87 -87
  8. package/runtime/velu-ui/components/ApiPath.jsx +63 -63
  9. package/runtime/velu-ui/components/ApiReferencePage.jsx +384 -384
  10. package/runtime/velu-ui/components/ApiSamples.jsx +36 -36
  11. package/runtime/velu-ui/components/ApiSidebar.jsx +122 -122
  12. package/runtime/velu-ui/components/AskBar.jsx +71 -71
  13. package/runtime/velu-ui/components/Callout.jsx +114 -114
  14. package/runtime/velu-ui/components/Card.jsx +131 -131
  15. package/runtime/velu-ui/components/Chatbot.jsx +885 -885
  16. package/runtime/velu-ui/components/CodeBlock.jsx +375 -375
  17. package/runtime/velu-ui/components/Columns.jsx +56 -56
  18. package/runtime/velu-ui/components/ContextMenu.jsx +298 -273
  19. package/runtime/velu-ui/components/ErrorCard.jsx +138 -138
  20. package/runtime/velu-ui/components/Field.jsx +81 -81
  21. package/runtime/velu-ui/components/Image.jsx +163 -163
  22. package/runtime/velu-ui/components/Logo.jsx +31 -31
  23. package/runtime/velu-ui/components/MethodBadge.jsx +31 -31
  24. package/runtime/velu-ui/components/NavSelect.jsx +108 -108
  25. package/runtime/velu-ui/components/NotFound.jsx +63 -63
  26. package/runtime/velu-ui/components/PageFeedback.jsx +219 -219
  27. package/runtime/velu-ui/components/PageFooter.jsx +145 -145
  28. package/runtime/velu-ui/components/PageHeader.jsx +422 -422
  29. package/runtime/velu-ui/components/PageNav.jsx +77 -77
  30. package/runtime/velu-ui/components/PoweredBy.jsx +51 -51
  31. package/runtime/velu-ui/components/Prompt.jsx +115 -115
  32. package/runtime/velu-ui/components/Search.jsx +460 -460
  33. package/runtime/velu-ui/components/Sidebar.jsx +254 -254
  34. package/runtime/velu-ui/components/SocialLinks.jsx +90 -90
  35. package/runtime/velu-ui/components/Steps.jsx +65 -65
  36. package/runtime/velu-ui/components/ThemeToggle.jsx +48 -48
  37. package/runtime/velu-ui/components/Toc.jsx +537 -537
  38. package/runtime/velu-ui/components/TocBar.jsx +195 -195
  39. package/runtime/velu-ui/components/Tree.jsx +87 -87
  40. package/runtime/velu-ui/components/TryItBar.jsx +102 -102
  41. package/runtime/velu-ui/components/accordion.css +92 -92
  42. package/runtime/velu-ui/components/api-page.css +208 -208
  43. package/runtime/velu-ui/components/api.css +635 -635
  44. package/runtime/velu-ui/components/ask-bar.css +94 -94
  45. package/runtime/velu-ui/components/card.css +105 -105
  46. package/runtime/velu-ui/components/chatbot.css +622 -622
  47. package/runtime/velu-ui/components/code-block.css +263 -263
  48. package/runtime/velu-ui/components/context-menu.css +173 -173
  49. package/runtime/velu-ui/components/docs-layout.css +822 -822
  50. package/runtime/velu-ui/components/field.css +82 -82
  51. package/runtime/velu-ui/components/image.css +237 -237
  52. package/runtime/velu-ui/components/nav-select.css +157 -157
  53. package/runtime/velu-ui/components/not-found.css +94 -94
  54. package/runtime/velu-ui/components/page-feedback.css +241 -241
  55. package/runtime/velu-ui/components/page-footer.css +130 -130
  56. package/runtime/velu-ui/components/page-header.css +558 -558
  57. package/runtime/velu-ui/components/page-nav.css +50 -50
  58. package/runtime/velu-ui/components/powered-by.css +92 -92
  59. package/runtime/velu-ui/components/prompt.css +99 -99
  60. package/runtime/velu-ui/components/search.css +307 -307
  61. package/runtime/velu-ui/components/sidebar.css +205 -205
  62. package/runtime/velu-ui/components/steps.css +77 -77
  63. package/runtime/velu-ui/components/theme-toggle.css +102 -102
  64. package/runtime/velu-ui/components/toc-bar.css +234 -234
  65. package/runtime/velu-ui/components/tree.css +49 -49
  66. package/runtime/velu-ui/index.js +54 -54
  67. package/runtime/velu-ui/lib/api-send.js +92 -92
  68. package/runtime/velu-ui/lib/brand-icons.jsx +103 -103
  69. package/runtime/velu-ui/lib/component-schemas.js +100 -100
  70. package/runtime/velu-ui/lib/copyText.js +64 -64
  71. package/runtime/velu-ui/lib/docs-assistant.js +250 -250
  72. package/runtime/velu-ui/lib/lang-icons.jsx +147 -147
  73. package/runtime/velu-ui/lib/pagefind.js +113 -113
  74. package/runtime/velu-ui/lib/prism-langs.js +957 -957
  75. package/runtime/velu-ui/lib/prism-loader.js +74 -74
  76. package/runtime/velu-ui/lib/resolveIcon.jsx +29 -29
  77. package/runtime/velu-ui/lib/scrollIntoNearestView.js +66 -66
  78. package/runtime/velu-ui/mdx-components.jsx +105 -105
  79. package/runtime/velu-ui/primitives/Cluster.jsx +49 -49
  80. package/runtime/velu-ui/primitives/Stack.jsx +63 -63
  81. package/runtime/velu-ui/primitives/Switcher.jsx +57 -57
  82. package/runtime/velu-ui/primitives/stack.css +3 -3
  83. package/runtime/velu-ui/primitives/switcher.css +25 -25
  84. package/runtime/velu-ui/styles.css +46 -46
  85. package/runtime/velu-ui/tokens.css +4 -4
  86. package/schema/velu.schema.json +423 -423
  87. package/src/lib/extract-mdx-error.js +170 -170
  88. package/src/lib/issues.js +159 -159
  89. package/src/lib/known-components.js +34 -34
  90. package/src/navigation.js +443 -443
  91. package/src/runtime/App.jsx +1669 -1668
  92. package/src/runtime/ErrorBoundary.jsx +54 -54
  93. package/src/runtime/client-entry.jsx +22 -22
  94. package/src/runtime/server-entry.jsx +16 -16
  95. package/src/template.html +48 -48
  96. package/templates/starter/ai-tools/claude-code.mdx +26 -26
  97. package/templates/starter/ai-tools/cursor.mdx +17 -17
  98. package/templates/starter/api-reference/introduction.mdx +43 -43
  99. package/templates/starter/development.mdx +19 -19
  100. package/templates/starter/essentials/code.mdx +29 -29
  101. package/templates/starter/essentials/images.mdx +29 -29
  102. package/templates/starter/essentials/markdown.mdx +25 -25
  103. package/templates/starter/essentials/navigation.mdx +39 -39
  104. package/templates/starter/essentials/settings.mdx +30 -30
  105. package/templates/starter/favicon.svg +6 -6
  106. package/templates/starter/index.mdx +31 -31
  107. package/templates/starter/openapi.json +160 -160
  108. package/templates/starter/quickstart.mdx +31 -31
  109. package/templates/starter/velu.json +41 -41
@@ -1,422 +1,422 @@
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
- import Logo from './Logo.jsx';
7
-
8
- /**
9
- * PageHeader — top of the docs site.
10
- *
11
- * <PageHeader
12
- * linkComponent={RouterLink}
13
- * brand={{ label: 'Velu', href: '/' }}
14
- * center={<Search />} // search + adjacent bits
15
- * actions={[
16
- * { label: 'Book Demo', kind: 'primary', href: '/demo' },
17
- * ]}
18
- * activeTab="/"
19
- * tabs={[
20
- * { label: 'Home', icon: 'home', href: '/' },
21
- * { label: 'Docs', icon: 'book', href: '/docs', external: true },
22
- * { label: 'Blog', icon: 'rss', href: '/blog' },
23
- * ]}
24
- * />
25
- *
26
- * Layout: a top row (3-column grid — brand | center | actions) plus an
27
- * optional tabs row below. All slots are fully data-driven; pass any
28
- * number of actions and any number of tabs.
29
- *
30
- * @typedef {Object} HeaderTab
31
- * @property {string} label
32
- * @property {string|React.ReactNode} [icon] lucide id or node
33
- * @property {string} [href]
34
- * @property {boolean} [active] explicit override
35
- * @property {boolean} [external] renders an outlink chip
36
- *
37
- * @typedef {Object} HeaderAction
38
- * @property {string} label
39
- * @property {string|React.ReactNode} [icon]
40
- * @property {'primary'|'outlined'} [kind] default 'outlined'
41
- * @property {string} [href]
42
- * @property {() => void} [onClick]
43
- * @property {boolean} [external]
44
- *
45
- * @param {{ brand?: { label?: string, href?: string },
46
- * center?: React.ReactNode, actions?: HeaderAction[],
47
- * tabs?: HeaderTab[], activeTab?: string,
48
- * linkComponent?: React.ElementType, className?: string }} props
49
- */
50
-
51
- /* Velu brand mark. Color: --accent-color via the wrapping wordmark
52
- span; the path uses currentColor. Exported so consumers (e.g. the
53
- mobile nav drawer) can render the mark alongside its own chrome. */
54
- export function VeluMark() {
55
- return (
56
- <svg
57
- className="velu-header__mark"
58
- viewBox="0 0 32 24"
59
- fill="currentColor"
60
- aria-hidden="true"
61
- >
62
- <path
63
- fillRule="evenodd"
64
- clipRule="evenodd"
65
- 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"
66
- />
67
- </svg>
68
- );
69
- }
70
-
71
- function ActionButton({ action, Link }) {
72
- const { label, icon, kind = 'outlined', href, onClick, external } = action;
73
- const cls = `velu-header__action velu-header__action--${kind}`;
74
- const content = (
75
- <>
76
- {icon && (
77
- <span className="velu-header__action-icon" aria-hidden="true">
78
- {resolveIcon(icon, { size: '1em' })}
79
- </span>
80
- )}
81
- <span>{label}</span>
82
- </>
83
- );
84
- if (href) {
85
- const Tag = external ? 'a' : Link;
86
- const extraProps = external
87
- ? { target: '_blank', rel: 'noreferrer' }
88
- : {};
89
- return (
90
- <Tag className={cls} href={href} {...extraProps}>
91
- {content}
92
- </Tag>
93
- );
94
- }
95
- return (
96
- <button type="button" className={cls} onClick={onClick}>
97
- {content}
98
- </button>
99
- );
100
- }
101
-
102
- function HeaderTab({ tab, isActive, Link }) {
103
- const { label, icon, href = '#', external } = tab;
104
- const cls = `velu-header__tab${isActive ? ' velu-header__tab--active' : ''}`;
105
- const Tag = external ? 'a' : Link;
106
- const extraProps = external
107
- ? { target: '_blank', rel: 'noreferrer' }
108
- : {};
109
- return (
110
- <Tag
111
- className={cls}
112
- href={href}
113
- aria-current={isActive ? 'page' : undefined}
114
- {...extraProps}
115
- >
116
- {icon && (
117
- <span className="velu-header__tab-icon" aria-hidden="true">
118
- {resolveIcon(icon, { size: '1.5em' })}
119
- </span>
120
- )}
121
- <span>{label}</span>
122
- {external && (
123
- <span className="velu-header__tab-external" aria-hidden="true">
124
- {resolveIcon('external-link', { size: '1em' })}
125
- </span>
126
- )}
127
- </Tag>
128
- );
129
- }
130
-
131
- /* Narrow-width overflow menu — the same `actions` items rendered as a
132
- simple vertical dropdown under a triple-dot button. CSS in
133
- page-header.css hides this component at wide widths and the inline
134
- action list at narrow widths so only one is ever visible.
135
- Click-outside + Escape close the menu. */
136
- function KebabMenu({ actions, Link }) {
137
- const [open, setOpen] = React.useState(false);
138
- const rootRef = React.useRef(null);
139
-
140
- React.useEffect(() => {
141
- if (!open) return;
142
- const onDocClick = (e) => {
143
- if (!rootRef.current?.contains(e.target)) setOpen(false);
144
- };
145
- const onKey = (e) => {
146
- if (e.key === 'Escape') setOpen(false);
147
- };
148
- document.addEventListener('mousedown', onDocClick);
149
- document.addEventListener('keydown', onKey);
150
- return () => {
151
- document.removeEventListener('mousedown', onDocClick);
152
- document.removeEventListener('keydown', onKey);
153
- };
154
- }, [open]);
155
-
156
- return (
157
- <div
158
- ref={rootRef}
159
- className="velu-header__kebab"
160
- data-open={open ? 'true' : 'false'}
161
- >
162
- <button
163
- type="button"
164
- className="velu-header__kebab-toggle"
165
- aria-label="More actions"
166
- aria-haspopup="menu"
167
- aria-expanded={open}
168
- onClick={() => setOpen((v) => !v)}
169
- >
170
- <MoreVertical aria-hidden="true" focusable="false" />
171
- </button>
172
- <ul className="velu-header__kebab-menu" role="menu" aria-hidden={!open}>
173
- {actions.map((a, i) => {
174
- const { label, icon, href, onClick, external } = a;
175
- const content = (
176
- <>
177
- {icon && (
178
- <span className="velu-header__kebab-icon" aria-hidden="true">
179
- {resolveIcon(icon, { size: '1em' })}
180
- </span>
181
- )}
182
- <span>{label}</span>
183
- </>
184
- );
185
- const close = () => setOpen(false);
186
- if (href) {
187
- const Tag = external ? 'a' : Link;
188
- const extra = external
189
- ? { target: '_blank', rel: 'noreferrer' }
190
- : {};
191
- return (
192
- <li key={i} role="none">
193
- <Tag
194
- role="menuitem"
195
- className="velu-header__kebab-item"
196
- href={href}
197
- onClick={close}
198
- tabIndex={open ? 0 : -1}
199
- {...extra}
200
- >
201
- {content}
202
- </Tag>
203
- </li>
204
- );
205
- }
206
- return (
207
- <li key={i} role="none">
208
- <button
209
- type="button"
210
- role="menuitem"
211
- className="velu-header__kebab-item"
212
- onClick={() => {
213
- onClick?.();
214
- close();
215
- }}
216
- tabIndex={open ? 0 : -1}
217
- >
218
- {content}
219
- </button>
220
- </li>
221
- );
222
- })}
223
- </ul>
224
- </div>
225
- );
226
- }
227
-
228
- export default function PageHeader({
229
- brand,
230
- brandTrailing,
231
- center,
232
- actions = [],
233
- trailing,
234
- tabs = [],
235
- tabsTrailing,
236
- activeTab,
237
- breadcrumb,
238
- onMenuClick,
239
- linkComponent = 'a',
240
- className = '',
241
- ...rest
242
- }) {
243
- const Link = linkComponent;
244
- const brandLabel = brand?.label ?? 'Velu';
245
- const brandHref = brand?.href;
246
-
247
- // Track whether the page has been scrolled so the header can flip
248
- // from solid to translucent / frosted. Edge-triggered (only updates
249
- // when crossing scrollY=0) so React doesn't re-render the header on
250
- // every scroll event.
251
- const [scrolled, setScrolled] = React.useState(false);
252
- React.useEffect(() => {
253
- const onScroll = () => {
254
- const next = window.scrollY > 0;
255
- setScrolled((prev) => (prev === next ? prev : next));
256
- };
257
- onScroll();
258
- window.addEventListener('scroll', onScroll, { passive: true });
259
- return () => window.removeEventListener('scroll', onScroll);
260
- }, []);
261
-
262
- // A configured logo replaces the mark + wordmark entirely (Mintlify-style).
263
- const brandBlock = (
264
- <Cluster space="var(--s-3)" align="center" className="velu-header__brand">
265
- {brand?.logo ? (
266
- <Logo logo={brand.logo} alt={brandLabel} />
267
- ) : (
268
- <>
269
- <VeluMark />
270
- <span className="velu-header__wordmark">{brandLabel}</span>
271
- </>
272
- )}
273
- </Cluster>
274
- );
275
-
276
- return (
277
- <Stack
278
- as="header"
279
- space="var(--s0)"
280
- className={`velu-header${scrolled ? ' velu-header--scrolled' : ''} ${className}`.trim()}
281
- {...rest}
282
- >
283
- {/* Top row — 3-column grid: brand | center | actions. */}
284
- <div className="velu-header__top">
285
- <Cluster
286
- space="var(--s-1)"
287
- align="center"
288
- className="velu-header__col velu-header__col--brand"
289
- >
290
- {brandHref ? (
291
- <Link href={brandHref} className="velu-header__brand-link">
292
- {brandBlock}
293
- </Link>
294
- ) : (
295
- brandBlock
296
- )}
297
- {/* Slot rendered right after the brand (e.g. version pill). */}
298
- {brandTrailing}
299
- </Cluster>
300
-
301
- {center && (
302
- <div className="velu-header__col velu-header__col--center">
303
- {center}
304
- </div>
305
- )}
306
-
307
- {(actions.length > 0 || trailing) && (
308
- <Cluster
309
- space="var(--s-2)"
310
- align="center"
311
- className="velu-header__col velu-header__col--actions"
312
- >
313
- {/* Inline action buttons — hidden at narrow widths (where
314
- the kebab takes over) via @container query in
315
- page-header.css. */}
316
- {actions.length > 0 && (
317
- <div className="velu-header__actions-list">
318
- {actions.map((a, i) => (
319
- <ActionButton key={i} action={a} Link={Link} />
320
- ))}
321
- </div>
322
- )}
323
- {trailing}
324
- {/* Kebab — only displayed at narrow widths. The dropdown
325
- surfaces the same `actions` items as the inline list,
326
- so the data source stays single. */}
327
- {actions.length > 0 && (
328
- <KebabMenu actions={actions} Link={Link} />
329
- )}
330
- </Cluster>
331
- )}
332
- </div>
333
-
334
- {/* Tabs row — at wide widths shows the `tabs` cluster; at mobile
335
- the tabs are CSS-hidden and the `breadcrumb` (if provided)
336
- takes their place. Burger stays at the trailing edge via
337
- margin-inline-start: auto on the burger button itself, so
338
- its position is unaffected by the breadcrumb's length. */}
339
- {(tabs.length > 0 ||
340
- (breadcrumb && breadcrumb.length > 0) ||
341
- tabsTrailing ||
342
- onMenuClick) && (
343
- <Cluster
344
- space="var(--s0)"
345
- align="center"
346
- className="velu-header__tabs"
347
- >
348
- {tabs.map((tab, i) => {
349
- const isActive =
350
- tab.active || (tab.href != null && tab.href === activeTab);
351
- return (
352
- <HeaderTab
353
- key={i}
354
- tab={tab}
355
- isActive={isActive}
356
- Link={Link}
357
- />
358
- );
359
- })}
360
- {/* Single-line breadcrumb. Hidden at wide widths (see
361
- page-header.css). When `onMenuClick` is provided the
362
- whole strip is a button that opens the nav drawer —
363
- individual segment links are deliberately collapsed
364
- into one tap target so the chevron + segments read as
365
- "open menu" rather than separate links. */}
366
- {breadcrumb && breadcrumb.length > 0 && (
367
- <button
368
- type="button"
369
- className="velu-header__crumbs"
370
- onClick={onMenuClick}
371
- aria-label="Open navigation menu"
372
- >
373
- {breadcrumb.map((c, i) => {
374
- const isLast = i === breadcrumb.length - 1;
375
- return (
376
- <React.Fragment key={i}>
377
- {i > 0 && (
378
- <ChevronRight
379
- className="velu-header__crumb-sep"
380
- aria-hidden="true"
381
- focusable="false"
382
- />
383
- )}
384
- <span
385
- className={`velu-header__crumb${
386
- isLast ? ' velu-header__crumb--current' : ''
387
- }`}
388
- >
389
- {c.label}
390
- </span>
391
- </React.Fragment>
392
- );
393
- })}
394
- </button>
395
- )}
396
- {/* Trailing slot at the bottom-right of the header (right end
397
- of the tabs row) — e.g. the language switcher. Pushed
398
- right via margin-auto; hidden on mobile (folds into the
399
- drawer) via page-header.css. */}
400
- {tabsTrailing && (
401
- <div className="velu-header__tabs-trailing">{tabsTrailing}</div>
402
- )}
403
- {/* Mobile-only burger — sits at the trailing edge of the tabs
404
- row via CSS (margin-inline-start: auto in page-header.css).
405
- Hidden at wider widths; visible at < 640px. Fires the
406
- consumer's `onMenuClick` so the parent decides what mobile
407
- navigation to surface (e.g. a slide-down menu). */}
408
- {onMenuClick && (
409
- <button
410
- type="button"
411
- className="velu-header__menu"
412
- aria-label="Open navigation menu"
413
- onClick={onMenuClick}
414
- >
415
- <Menu aria-hidden="true" focusable="false" />
416
- </button>
417
- )}
418
- </Cluster>
419
- )}
420
- </Stack>
421
- );
422
- }
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
+ import Logo from './Logo.jsx';
7
+
8
+ /**
9
+ * PageHeader — top of the docs site.
10
+ *
11
+ * <PageHeader
12
+ * linkComponent={RouterLink}
13
+ * brand={{ label: 'Velu', href: '/' }}
14
+ * center={<Search />} // search + adjacent bits
15
+ * actions={[
16
+ * { label: 'Book Demo', kind: 'primary', href: '/demo' },
17
+ * ]}
18
+ * activeTab="/"
19
+ * tabs={[
20
+ * { label: 'Home', icon: 'home', href: '/' },
21
+ * { label: 'Docs', icon: 'book', href: '/docs', external: true },
22
+ * { label: 'Blog', icon: 'rss', href: '/blog' },
23
+ * ]}
24
+ * />
25
+ *
26
+ * Layout: a top row (3-column grid — brand | center | actions) plus an
27
+ * optional tabs row below. All slots are fully data-driven; pass any
28
+ * number of actions and any number of tabs.
29
+ *
30
+ * @typedef {Object} HeaderTab
31
+ * @property {string} label
32
+ * @property {string|React.ReactNode} [icon] lucide id or node
33
+ * @property {string} [href]
34
+ * @property {boolean} [active] explicit override
35
+ * @property {boolean} [external] renders an outlink chip
36
+ *
37
+ * @typedef {Object} HeaderAction
38
+ * @property {string} label
39
+ * @property {string|React.ReactNode} [icon]
40
+ * @property {'primary'|'outlined'} [kind] default 'outlined'
41
+ * @property {string} [href]
42
+ * @property {() => void} [onClick]
43
+ * @property {boolean} [external]
44
+ *
45
+ * @param {{ brand?: { label?: string, href?: string },
46
+ * center?: React.ReactNode, actions?: HeaderAction[],
47
+ * tabs?: HeaderTab[], activeTab?: string,
48
+ * linkComponent?: React.ElementType, className?: string }} props
49
+ */
50
+
51
+ /* Velu brand mark. Color: --accent-color via the wrapping wordmark
52
+ span; the path uses currentColor. Exported so consumers (e.g. the
53
+ mobile nav drawer) can render the mark alongside its own chrome. */
54
+ export function VeluMark() {
55
+ return (
56
+ <svg
57
+ className="velu-header__mark"
58
+ viewBox="0 0 32 24"
59
+ fill="currentColor"
60
+ aria-hidden="true"
61
+ >
62
+ <path
63
+ fillRule="evenodd"
64
+ clipRule="evenodd"
65
+ 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"
66
+ />
67
+ </svg>
68
+ );
69
+ }
70
+
71
+ function ActionButton({ action, Link }) {
72
+ const { label, icon, kind = 'outlined', href, onClick, external } = action;
73
+ const cls = `velu-header__action velu-header__action--${kind}`;
74
+ const content = (
75
+ <>
76
+ {icon && (
77
+ <span className="velu-header__action-icon" aria-hidden="true">
78
+ {resolveIcon(icon, { size: '1em' })}
79
+ </span>
80
+ )}
81
+ <span>{label}</span>
82
+ </>
83
+ );
84
+ if (href) {
85
+ const Tag = external ? 'a' : Link;
86
+ const extraProps = external
87
+ ? { target: '_blank', rel: 'noreferrer' }
88
+ : {};
89
+ return (
90
+ <Tag className={cls} href={href} {...extraProps}>
91
+ {content}
92
+ </Tag>
93
+ );
94
+ }
95
+ return (
96
+ <button type="button" className={cls} onClick={onClick}>
97
+ {content}
98
+ </button>
99
+ );
100
+ }
101
+
102
+ function HeaderTab({ tab, isActive, Link }) {
103
+ const { label, icon, href = '#', external } = tab;
104
+ const cls = `velu-header__tab${isActive ? ' velu-header__tab--active' : ''}`;
105
+ const Tag = external ? 'a' : Link;
106
+ const extraProps = external
107
+ ? { target: '_blank', rel: 'noreferrer' }
108
+ : {};
109
+ return (
110
+ <Tag
111
+ className={cls}
112
+ href={href}
113
+ aria-current={isActive ? 'page' : undefined}
114
+ {...extraProps}
115
+ >
116
+ {icon && (
117
+ <span className="velu-header__tab-icon" aria-hidden="true">
118
+ {resolveIcon(icon, { size: '1.5em' })}
119
+ </span>
120
+ )}
121
+ <span>{label}</span>
122
+ {external && (
123
+ <span className="velu-header__tab-external" aria-hidden="true">
124
+ {resolveIcon('external-link', { size: '1em' })}
125
+ </span>
126
+ )}
127
+ </Tag>
128
+ );
129
+ }
130
+
131
+ /* Narrow-width overflow menu — the same `actions` items rendered as a
132
+ simple vertical dropdown under a triple-dot button. CSS in
133
+ page-header.css hides this component at wide widths and the inline
134
+ action list at narrow widths so only one is ever visible.
135
+ Click-outside + Escape close the menu. */
136
+ function KebabMenu({ actions, Link }) {
137
+ const [open, setOpen] = React.useState(false);
138
+ const rootRef = React.useRef(null);
139
+
140
+ React.useEffect(() => {
141
+ if (!open) return;
142
+ const onDocClick = (e) => {
143
+ if (!rootRef.current?.contains(e.target)) setOpen(false);
144
+ };
145
+ const onKey = (e) => {
146
+ if (e.key === 'Escape') setOpen(false);
147
+ };
148
+ document.addEventListener('mousedown', onDocClick);
149
+ document.addEventListener('keydown', onKey);
150
+ return () => {
151
+ document.removeEventListener('mousedown', onDocClick);
152
+ document.removeEventListener('keydown', onKey);
153
+ };
154
+ }, [open]);
155
+
156
+ return (
157
+ <div
158
+ ref={rootRef}
159
+ className="velu-header__kebab"
160
+ data-open={open ? 'true' : 'false'}
161
+ >
162
+ <button
163
+ type="button"
164
+ className="velu-header__kebab-toggle"
165
+ aria-label="More actions"
166
+ aria-haspopup="menu"
167
+ aria-expanded={open}
168
+ onClick={() => setOpen((v) => !v)}
169
+ >
170
+ <MoreVertical aria-hidden="true" focusable="false" />
171
+ </button>
172
+ <ul className="velu-header__kebab-menu" role="menu" aria-hidden={!open}>
173
+ {actions.map((a, i) => {
174
+ const { label, icon, href, onClick, external } = a;
175
+ const content = (
176
+ <>
177
+ {icon && (
178
+ <span className="velu-header__kebab-icon" aria-hidden="true">
179
+ {resolveIcon(icon, { size: '1em' })}
180
+ </span>
181
+ )}
182
+ <span>{label}</span>
183
+ </>
184
+ );
185
+ const close = () => setOpen(false);
186
+ if (href) {
187
+ const Tag = external ? 'a' : Link;
188
+ const extra = external
189
+ ? { target: '_blank', rel: 'noreferrer' }
190
+ : {};
191
+ return (
192
+ <li key={i} role="none">
193
+ <Tag
194
+ role="menuitem"
195
+ className="velu-header__kebab-item"
196
+ href={href}
197
+ onClick={close}
198
+ tabIndex={open ? 0 : -1}
199
+ {...extra}
200
+ >
201
+ {content}
202
+ </Tag>
203
+ </li>
204
+ );
205
+ }
206
+ return (
207
+ <li key={i} role="none">
208
+ <button
209
+ type="button"
210
+ role="menuitem"
211
+ className="velu-header__kebab-item"
212
+ onClick={() => {
213
+ onClick?.();
214
+ close();
215
+ }}
216
+ tabIndex={open ? 0 : -1}
217
+ >
218
+ {content}
219
+ </button>
220
+ </li>
221
+ );
222
+ })}
223
+ </ul>
224
+ </div>
225
+ );
226
+ }
227
+
228
+ export default function PageHeader({
229
+ brand,
230
+ brandTrailing,
231
+ center,
232
+ actions = [],
233
+ trailing,
234
+ tabs = [],
235
+ tabsTrailing,
236
+ activeTab,
237
+ breadcrumb,
238
+ onMenuClick,
239
+ linkComponent = 'a',
240
+ className = '',
241
+ ...rest
242
+ }) {
243
+ const Link = linkComponent;
244
+ const brandLabel = brand?.label ?? 'Velu';
245
+ const brandHref = brand?.href;
246
+
247
+ // Track whether the page has been scrolled so the header can flip
248
+ // from solid to translucent / frosted. Edge-triggered (only updates
249
+ // when crossing scrollY=0) so React doesn't re-render the header on
250
+ // every scroll event.
251
+ const [scrolled, setScrolled] = React.useState(false);
252
+ React.useEffect(() => {
253
+ const onScroll = () => {
254
+ const next = window.scrollY > 0;
255
+ setScrolled((prev) => (prev === next ? prev : next));
256
+ };
257
+ onScroll();
258
+ window.addEventListener('scroll', onScroll, { passive: true });
259
+ return () => window.removeEventListener('scroll', onScroll);
260
+ }, []);
261
+
262
+ // A configured logo replaces the mark + wordmark entirely (Mintlify-style).
263
+ const brandBlock = (
264
+ <Cluster space="var(--s-3)" align="center" className="velu-header__brand">
265
+ {brand?.logo ? (
266
+ <Logo logo={brand.logo} alt={brandLabel} />
267
+ ) : (
268
+ <>
269
+ <VeluMark />
270
+ <span className="velu-header__wordmark">{brandLabel}</span>
271
+ </>
272
+ )}
273
+ </Cluster>
274
+ );
275
+
276
+ return (
277
+ <Stack
278
+ as="header"
279
+ space="var(--s0)"
280
+ className={`velu-header${scrolled ? ' velu-header--scrolled' : ''} ${className}`.trim()}
281
+ {...rest}
282
+ >
283
+ {/* Top row — 3-column grid: brand | center | actions. */}
284
+ <div className="velu-header__top">
285
+ <Cluster
286
+ space="var(--s-1)"
287
+ align="center"
288
+ className="velu-header__col velu-header__col--brand"
289
+ >
290
+ {brandHref ? (
291
+ <Link href={brandHref} className="velu-header__brand-link">
292
+ {brandBlock}
293
+ </Link>
294
+ ) : (
295
+ brandBlock
296
+ )}
297
+ {/* Slot rendered right after the brand (e.g. version pill). */}
298
+ {brandTrailing}
299
+ </Cluster>
300
+
301
+ {center && (
302
+ <div className="velu-header__col velu-header__col--center">
303
+ {center}
304
+ </div>
305
+ )}
306
+
307
+ {(actions.length > 0 || trailing) && (
308
+ <Cluster
309
+ space="var(--s-2)"
310
+ align="center"
311
+ className="velu-header__col velu-header__col--actions"
312
+ >
313
+ {/* Inline action buttons — hidden at narrow widths (where
314
+ the kebab takes over) via @container query in
315
+ page-header.css. */}
316
+ {actions.length > 0 && (
317
+ <div className="velu-header__actions-list">
318
+ {actions.map((a, i) => (
319
+ <ActionButton key={i} action={a} Link={Link} />
320
+ ))}
321
+ </div>
322
+ )}
323
+ {trailing}
324
+ {/* Kebab — only displayed at narrow widths. The dropdown
325
+ surfaces the same `actions` items as the inline list,
326
+ so the data source stays single. */}
327
+ {actions.length > 0 && (
328
+ <KebabMenu actions={actions} Link={Link} />
329
+ )}
330
+ </Cluster>
331
+ )}
332
+ </div>
333
+
334
+ {/* Tabs row — at wide widths shows the `tabs` cluster; at mobile
335
+ the tabs are CSS-hidden and the `breadcrumb` (if provided)
336
+ takes their place. Burger stays at the trailing edge via
337
+ margin-inline-start: auto on the burger button itself, so
338
+ its position is unaffected by the breadcrumb's length. */}
339
+ {(tabs.length > 0 ||
340
+ (breadcrumb && breadcrumb.length > 0) ||
341
+ tabsTrailing ||
342
+ onMenuClick) && (
343
+ <Cluster
344
+ space="var(--s0)"
345
+ align="center"
346
+ className="velu-header__tabs"
347
+ >
348
+ {tabs.map((tab, i) => {
349
+ const isActive =
350
+ tab.active || (tab.href != null && tab.href === activeTab);
351
+ return (
352
+ <HeaderTab
353
+ key={i}
354
+ tab={tab}
355
+ isActive={isActive}
356
+ Link={Link}
357
+ />
358
+ );
359
+ })}
360
+ {/* Single-line breadcrumb. Hidden at wide widths (see
361
+ page-header.css). When `onMenuClick` is provided the
362
+ whole strip is a button that opens the nav drawer —
363
+ individual segment links are deliberately collapsed
364
+ into one tap target so the chevron + segments read as
365
+ "open menu" rather than separate links. */}
366
+ {breadcrumb && breadcrumb.length > 0 && (
367
+ <button
368
+ type="button"
369
+ className="velu-header__crumbs"
370
+ onClick={onMenuClick}
371
+ aria-label="Open navigation menu"
372
+ >
373
+ {breadcrumb.map((c, i) => {
374
+ const isLast = i === breadcrumb.length - 1;
375
+ return (
376
+ <React.Fragment key={i}>
377
+ {i > 0 && (
378
+ <ChevronRight
379
+ className="velu-header__crumb-sep"
380
+ aria-hidden="true"
381
+ focusable="false"
382
+ />
383
+ )}
384
+ <span
385
+ className={`velu-header__crumb${
386
+ isLast ? ' velu-header__crumb--current' : ''
387
+ }`}
388
+ >
389
+ {c.label}
390
+ </span>
391
+ </React.Fragment>
392
+ );
393
+ })}
394
+ </button>
395
+ )}
396
+ {/* Trailing slot at the bottom-right of the header (right end
397
+ of the tabs row) — e.g. the language switcher. Pushed
398
+ right via margin-auto; hidden on mobile (folds into the
399
+ drawer) via page-header.css. */}
400
+ {tabsTrailing && (
401
+ <div className="velu-header__tabs-trailing">{tabsTrailing}</div>
402
+ )}
403
+ {/* Mobile-only burger — sits at the trailing edge of the tabs
404
+ row via CSS (margin-inline-start: auto in page-header.css).
405
+ Hidden at wider widths; visible at < 640px. Fires the
406
+ consumer's `onMenuClick` so the parent decides what mobile
407
+ navigation to surface (e.g. a slide-down menu). */}
408
+ {onMenuClick && (
409
+ <button
410
+ type="button"
411
+ className="velu-header__menu"
412
+ aria-label="Open navigation menu"
413
+ onClick={onMenuClick}
414
+ >
415
+ <Menu aria-hidden="true" focusable="false" />
416
+ </button>
417
+ )}
418
+ </Cluster>
419
+ )}
420
+ </Stack>
421
+ );
422
+ }