129 lines
8.8 KiB
Plaintext
129 lines
8.8 KiB
Plaintext
page Breadcrumbscomponent {
|
|
seo {
|
|
title = "Breadcrumbs component"
|
|
description = "Reusable breadcrumbs 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.76</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">Breadcrumbs</span></nav><section class="doc-intro"><span class="eyebrow">core component</span><h1>Breadcrumbs</h1><p>Reusable breadcrumbs component.</p><div class="doc-meta"><span>@wrnexus/ui 0.2.76</span><span>7 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><Breadcrumbs
|
|
items="[]"
|
|
centered="false"
|
|
compact="false"
|
|
showHome="true"
|
|
homeLabel="Home"
|
|
/></code></pre><p>Legacy mount name: <code>data-component="Breadcrumbs"</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>""</code></td></tr><tr><td><code>items</code></td><td><code>string</code></td><td>Optional</td><td><code>[]</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>showHome</code></td><td><code>boolean</code></td><td>Optional</td><td><code>true</code></td></tr><tr><td><code>homeLabel</code></td><td><code>string</code></td><td>Optional</td><td><code>"Home"</code></td></tr><tr><td><code>homeHref</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/Breadcrumbs.wrn</code></p><pre data-language="wrn"><code>component Breadcrumbs {
|
|
props {
|
|
class: string = ""
|
|
items = []
|
|
centered = false
|
|
compact = false
|
|
showHome = true
|
|
homeLabel = "Home"
|
|
homeHref = "/"
|
|
}
|
|
|
|
view {
|
|
<nav
|
|
aria-label="Breadcrumb"
|
|
class="w-full {class}"
|
|
class:hidden="items.length === 0 && !showHome"
|
|
>
|
|
<ol
|
|
class="flex flex-wrap items-center text-slate-500 dark:text-slate-400"
|
|
class:justify-center="centered"
|
|
class:gap-1.5="compact"
|
|
class:text-xs="compact"
|
|
class:gap-2="!compact"
|
|
class:text-sm="!compact"
|
|
>
|
|
<!-- Home -->
|
|
<li
|
|
class:hidden="!showHome"
|
|
class:inline-flex="showHome"
|
|
>
|
|
<a
|
|
href="{homeHref}"
|
|
class="group inline-flex items-center gap-1.5 rounded-lg transition hover:text-indigo-700 focus:outline-none focus-visible:ring-2 focus-visible:ring-indigo-500 dark:hover:text-indigo-300"
|
|
>
|
|
<span class="icon-[lucide--home] h-3.5 w-3.5" aria-hidden="true" >
|
|
</span>
|
|
<span class:hidden="compact">
|
|
{homeLabel}
|
|
</span>
|
|
<span
|
|
class="sr-only"
|
|
class:hidden="!compact"
|
|
>
|
|
{homeLabel}
|
|
</span>
|
|
</a>
|
|
</li>
|
|
<!-- Separator after home -->
|
|
<li
|
|
aria-hidden="true"
|
|
class="text-slate-300 dark:text-slate-700"
|
|
class:hidden="!showHome || items.length === 0"
|
|
class:inline-flex="showHome && items.length > 0"
|
|
>
|
|
<span class="icon-[lucide--chevron-right] h-3.5 w-3.5" >
|
|
</span>
|
|
</li>
|
|
<!-- Dynamic breadcrumb items -->
|
|
{#each items as item, index}
|
|
<li class="inline-flex min-w-0 items-center gap-2">
|
|
<!-- Linked item -->
|
|
<a
|
|
href="{item.href}"
|
|
class="max-w-48 truncate rounded-lg transition hover:text-indigo-700 focus:outline-none focus-visible:ring-2 focus-visible:ring-indigo-500 dark:hover:text-indigo-300 sm:max-w-64"
|
|
class:hidden="item.current || item.href === ''"
|
|
class:inline-flex="!item.current && item.href !== ''"
|
|
>
|
|
{item.label}
|
|
</a>
|
|
<!-- Current item -->
|
|
<span
|
|
aria-current="page"
|
|
class="max-w-48 truncate font-semibold text-slate-950 dark:text-white sm:max-w-64"
|
|
class:hidden="!item.current"
|
|
class:inline-flex="item.current"
|
|
>
|
|
{item.label}
|
|
</span>
|
|
<!-- Plain unlinked item -->
|
|
<span
|
|
class="max-w-48 truncate text-slate-600 dark:text-slate-300 sm:max-w-64"
|
|
class:hidden="item.current || item.href !== ''"
|
|
class:inline-flex="!item.current && item.href === ''"
|
|
>
|
|
{item.label}
|
|
</span>
|
|
<!-- Separator -->
|
|
<span
|
|
aria-hidden="true"
|
|
class="inline-flex text-slate-300 dark:text-slate-700"
|
|
class:hidden="index === items.length - 1"
|
|
>
|
|
<span class="icon-[lucide--chevron-right] h-3.5 w-3.5" >
|
|
</span>
|
|
</span>
|
|
</li>
|
|
{/each}
|
|
</ol>
|
|
</nav>
|
|
}
|
|
}
|
|
</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.76</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>
|
|
}
|
|
}
|