Files
WRNexusJSDoc/app/pages/components/page-header.wrn
T

194 lines
15 KiB
Plaintext

page PageHeadercomponent {
seo {
title = "PageHeader component"
description = "Reusable page header component."
}
view {
<div class="docs-shell">
<SkipLink label="Skip to content" href="#main" class="docs-skip-link" />
<header class="topbar">
<a class="brand" href="/"><span>W</span> WRNexusJS</a>
<nav aria-label="Primary"><a href="/getting-started">Get started</a><a href="/packages">Packages</a><a href="/components">Components</a><a href="/language">Language</a><a href="/architecture">Architecture</a></nav>
<div class="topbar-actions"><a class="preview-pill" href="/access">Private preview · v0.2.78</a><button data-wire-theme-toggle class="theme-button" aria-label="Toggle color theme" title="Toggle color theme">◐</button></div>
</header>
<div class="mobile-doc-nav"><details><summary>Browse documentation</summary><nav><a href="/getting-started">Get started</a><a href="/packages">Packages</a><a href="/components">Components</a><a href="/language">Language</a><a href="/architecture">Architecture</a><a href="/tutorial">Tutorial</a><a href="/guides/project-structure">Guides</a><a href="/examples">Examples</a><a href="/search">Search</a></nav></details></div>
<main class="portal-main docs-layout component-detail-page"><article id="main" class="documentation prose standalone"><nav class="breadcrumbs" aria-label="Breadcrumb"><a href="/">Home</a><span>/</span><a href="/components">Components</a><span>/</span><span aria-current="page">PageHeader</span></nav><section class="doc-intro"><span class="eyebrow">core component</span><h1>PageHeader</h1><p>Reusable page header component.</p><div class="doc-meta"><span>@wrnexus/ui 0.2.78</span><span>16 props</span><span>0 slots</span><span>0 events</span></div></section><section id="usage"><h2>Usage</h2><p>Components are auto-discovered. Use the component directly in any <code>.wrn</code> view:</p><pre data-language="wrn"><code>&lt;PageHeader
eyebrow=&quot;eyebrow&quot;
title=&quot;title&quot;
description=&quot;description&quot;
primaryLabel=&quot;primaryLabel&quot;
primaryHref=&quot;primaryHref&quot;
/&gt;</code></pre><p>Legacy mount name: <code>data-component=&quot;PageHeader&quot;</code>.</p></section><section id="props"><h2>Props and attributes</h2><div class="table-wrap"><table><thead><tr><th>Prop</th><th>Type</th><th>Requirement</th><th>Default</th></tr></thead><tbody><tr><td><code>class</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>eyebrow</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>title</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>description</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>primaryLabel</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>primaryHref</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>secondaryLabel</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>secondaryHref</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>icon</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;sparkles&quot;</code></td></tr><tr><td><code>centered</code></td><td><code>boolean</code></td><td>Optional</td><td><code>false</code></td></tr><tr><td><code>compact</code></td><td><code>boolean</code></td><td>Optional</td><td><code>false</code></td></tr><tr><td><code>showBreadcrumbs</code></td><td><code>boolean</code></td><td>Optional</td><td><code>false</code></td></tr><tr><td><code>breadcrumbParent</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>breadcrumbParentHref</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>breadcrumbCurrent</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>highlights</code></td><td><code>string</code></td><td>Optional</td><td><code>[]</code></td></tr></tbody></table></div></section><section id="slots"><h2>Slots</h2><p>This component does not declare a slot.</p></section><section id="events"><h2>Events</h2><p>This component does not declare a custom event.</p></section><section id="source"><h2>Source contract</h2><p>Installed source: <code>components/PageHeader.wrn</code></p><pre data-language="wrn"><code>component PageHeader &#123;
props &#123;
class: string = &quot;&quot;
eyebrow = &quot;&quot;
title = &quot;&quot;
description = &quot;&quot;
primaryLabel = &quot;&quot;
primaryHref = &quot;&quot;
secondaryLabel = &quot;&quot;
secondaryHref = &quot;&quot;
icon = &quot;sparkles&quot;
centered = false
compact = false
showBreadcrumbs = false
breadcrumbParent = &quot;&quot;
breadcrumbParentHref = &quot;&quot;
breadcrumbCurrent = &quot;&quot;
highlights = []
&#125;
view &#123;
&lt;section
aria-labelledby=&quot;public-page-title&quot;
class=&quot;relative overflow-hidden border-b border-slate-200 bg-white dark:border-white/10 dark:bg-slate-950 &#123;class&#125;&quot;
&gt;
&lt;!-- Background decoration --&gt;
&lt;div
aria-hidden=&quot;true&quot;
class=&quot;pointer-events-none absolute inset-0 overflow-hidden&quot;
&gt;
&lt;div class=&quot;absolute -right-40 -top-48 h-96 w-96 rounded-full bg-indigo-300/20 blur-3xl dark:bg-indigo-500/10&quot; &gt;
&lt;/div&gt;
&lt;div class=&quot;absolute -left-40 top-20 h-80 w-80 rounded-full bg-violet-300/15 blur-3xl dark:bg-violet-500/5&quot; &gt;
&lt;/div&gt;
&lt;div class=&quot;absolute left-1/2 top-0 h-px w-2/3 -translate-x-1/2 bg-linear-to-r from-transparent via-indigo-300/60 to-transparent dark:via-indigo-500/20&quot; &gt;
&lt;/div&gt;
&lt;/div&gt;
&lt;div class=&quot;relative w-full px-5 sm:px-8 lg:px-10 xl:px-12&quot;&gt;
&lt;!-- Breadcrumbs --&gt;
&lt;div
class=&quot;border-b border-slate-200/80 py-3 dark:border-white/10&quot;
class:hidden=&quot;!showBreadcrumbs&quot;
&gt;
&lt;Breadcrumbs
centered=&quot;&#123;centered&#125;&quot;
compact=&quot;&#123;false&#125;&quot;
items=&quot;&#123;[ ...(breadcrumbParent !== '' ? [&#123; label: breadcrumbParent, href: breadcrumbParentHref, current: false &#125;] : []), ...(breadcrumbCurrent !== '' ? [&#123; label: breadcrumbCurrent, href: '', current: true &#125;] : []) ]&#125;&quot;
/&gt;
&lt;/div&gt;
&lt;!-- Header body --&gt;
&lt;div
class=&quot; &#123;compact ? 'py-9 sm:py-10 lg:py-12' : 'py-12 sm:py-14 lg:py-16' &#125; &#123;centered ? 'mx-auto flex max-w-5xl flex-col items-center text-center' : 'grid gap-8 lg:grid-cols-[minmax(0,1fr)_auto] lg:items-start lg:gap-12' &#125; &quot;
&gt;
&lt;!-- Content --&gt;
&lt;div class=&quot; min-w-0 &#123;centered ? 'w-full max-w-4xl' : 'max-w-4xl'&#125; &quot; &gt;
&lt;!-- Eyebrow --&gt;
&lt;div
class=&quot;flex&quot;
class:hidden=&quot;eyebrow === ''&quot;
class:justify-center=&quot;centered&quot;
class:justify-start=&quot;!centered&quot;
&gt;
&lt;span
class=&quot;inline-flex items-center gap-2 rounded-full border border-indigo-200 bg-indigo-50 px-3 py-1.5 text-xs font-semibold text-indigo-700 shadow-sm dark:border-indigo-500/20 dark:bg-indigo-500/10 dark:text-indigo-300&quot;
&gt;
&lt;span class=&quot;grid h-5 w-5 place-items-center rounded-full bg-indigo-100 dark:bg-indigo-500/15&quot; &gt;
&lt;span class=&quot;icon-[lucide--&#123;icon&#125;] h-3 w-3&quot; aria-hidden=&quot;true&quot; &gt;
&lt;/span&gt;
&lt;/span&gt;
&#123;eyebrow&#125;
&lt;/span&gt;
&lt;/div&gt;
&lt;!-- Title --&gt;
&lt;h1
id=&quot;public-page-title&quot;
class=&quot; font-bold tracking-tight text-slate-950 dark:text-white &#123;eyebrow !== '' ? 'mt-6' : ''&#125; &#123;compact ? 'text-3xl leading-tight sm:text-4xl lg:text-5xl' : 'text-4xl leading-[1.08] sm:text-5xl lg:text-[3.25rem]' &#125; &quot;
&gt;
&#123;title&#125;
&lt;/h1&gt;
&lt;!-- Description --&gt;
&lt;p
class=&quot; mt-5 text-base text-slate-600 dark:text-slate-400 &#123;compact ? 'leading-7' : 'leading-8 sm:text-lg'&#125; &#123;centered ? 'mx-auto max-w-3xl' : 'max-w-2xl'&#125; &quot;
class:hidden=&quot;description === ''&quot;
&gt;
&#123;description&#125;
&lt;/p&gt;
&lt;/div&gt;
&lt;!-- Single dynamic action group --&gt;
&lt;div
class=&quot; flex flex-col gap-3 sm:flex-row &#123;centered ? 'mt-8 justify-center' : 'lg:pt-1' &#125; &quot;
class:hidden=&quot;primaryLabel === '' &amp;&amp; secondaryLabel === ''&quot;
&gt;
&lt;!-- Secondary action --&gt;
&lt;a
href=&quot;&#123;secondaryHref&#125;&quot;
class=&quot;h-12 items-center justify-center rounded-xl border border-slate-200 bg-white px-5 text-sm font-semibold text-slate-700 shadow-sm transition hover:-translate-y-0.5 hover:border-indigo-300 hover:bg-slate-50 hover:text-indigo-700 focus:outline-none focus-visible:ring-2 focus-visible:ring-indigo-500 dark:border-white/10 dark:bg-white/5 dark:text-slate-200 dark:hover:border-indigo-500/30 dark:hover:bg-white/10 dark:hover:text-indigo-300&quot;
class:hidden=&quot;secondaryLabel === ''&quot;
class:inline-flex=&quot;secondaryLabel !== ''&quot;
&gt;
&#123;secondaryLabel&#125;
&lt;/a&gt;
&lt;!-- Primary action --&gt;
&lt;a
href=&quot;&#123;primaryHref&#125;&quot;
class=&quot;group h-12 items-center justify-center gap-2 rounded-xl bg-indigo-600 px-5 text-sm font-bold text-white shadow-lg shadow-indigo-600/20 transition hover:-translate-y-0.5 hover:bg-indigo-500 hover:shadow-xl focus:outline-none focus-visible:ring-2 focus-visible:ring-indigo-500 focus-visible:ring-offset-2 dark:focus-visible:ring-offset-slate-950&quot;
class:hidden=&quot;primaryLabel === ''&quot;
class:inline-flex=&quot;primaryLabel !== ''&quot;
&gt;
&#123;primaryLabel&#125;
&lt;span class=&quot;icon-[lucide--arrow-right] h-4 w-4 transition-transform group-hover:translate-x-1&quot; aria-hidden=&quot;true&quot; &gt;
&lt;/span&gt;
&lt;/a&gt;
&lt;/div&gt;
&lt;/div&gt;
&lt;!-- Dynamic highlight strip --&gt;
&lt;div
class=&quot;border-t border-slate-200 py-5 dark:border-white/10&quot;
class:hidden=&quot;compact || highlights.length === 0&quot;
class:block=&quot;!compact &amp;&amp; highlights.length &gt; 0&quot;
&gt;
&lt;div class=&quot;flex gap-y-5&quot;&gt;
&#123;#each highlights as highlight&#125;
&lt;div
class=&quot;w-full min-w-0 pr-6&quot;
class:w-full=&quot;highlights.length === 1&quot;
class:sm:w-1/2=&quot;highlights.length &gt;= 2&quot;
class:lg:w-1/2=&quot;highlights.length === 2&quot;
class:lg:w-1/3=&quot;highlights.length === 3&quot;
class:lg:w-1/4=&quot;highlights.length &gt;= 4&quot;
&gt;
&lt;div
class=&quot;flex min-w-0 items-center gap-3&quot;
class:justify-center=&quot;centered&quot;
&gt;
&lt;span class=&quot;grid h-10 w-10 shrink-0 place-items-center rounded-xl &#123;highlight.iconBoxClass&#125;&quot; &gt;
&lt;span class=&quot;&#123;highlight.iconClass&#125; h-5 w-5&quot; aria-hidden=&quot;true&quot; &gt;
&lt;/span&gt;
&lt;/span&gt;
&lt;div class=&quot;min-w-0&quot;&gt;
&lt;p class=&quot;text-sm font-semibold text-slate-950 dark:text-white&quot;&gt;
&#123;highlight.title&#125;
&lt;/p&gt;
&lt;p
class=&quot;mt-0.5 text-xs leading-5 text-slate-500 dark:text-slate-400&quot;
class:hidden=&quot;highlight.description === ''&quot;
&gt;
&#123;highlight.description&#125;
&lt;/p&gt;
&lt;/div&gt;
&lt;/div&gt;
&lt;/div&gt;
&#123;/each&#125;
&lt;/div&gt;
&lt;/div&gt;
&lt;/div&gt;
&lt;/section&gt;
&#125;
&#125;
</code></pre></section></article><aside class="on-this-page"><h2>On this page</h2><nav><a href="#usage">Usage</a><a href="#props">Props and attributes</a><a href="#slots">Slots</a><a href="#events">Events</a><a href="#source">Source contract</a></nav></aside></main>
<footer><div class="footer-brand"><span class="footer-mark" aria-hidden="true">W</span><p><strong>WRNexusJS 0.2.78</strong><span>Complete API documentation generated from installed package declarations.</span></p></div><nav aria-label="Footer"><a href="/packages">All packages</a><a href="/getting-started">Get started</a><a href="/security">Security</a><a href="/support">Support</a><a href="/llms.txt">AI guide</a></nav><p class="footer-meta">Private Developer Preview · Bun-native</p></footer>
<BackToTop />
</div>
}
}