Files
WRNexusJSDoc/app/pages/components/card.wrn
T

291 lines
19 KiB
Plaintext

page Cardcomponent {
seo {
title = "Card component"
description = "Theme-aware, responsive card 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.5.0</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">Card</span></nav><section class="doc-intro"><span class="eyebrow">base component</span><h1>Card</h1><p>Theme-aware, responsive card component.</p><div class="doc-meta"><span>@wrnexus/ui 0.5.0</span><span>31 props</span><span>1 slots</span><span>6 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;Card
title=&quot;Card title&quot;
subtitle=&quot;subtitle&quot;
description=&quot;description&quot;
header=&quot;header&quot;
footer=&quot;footer&quot;
/&gt;</code></pre><p>Legacy mount name: <code>data-component=&quot;Card&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>title</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;Card title&quot;</code></td></tr><tr><td><code>subtitle</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>header</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>footer</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>imageSrc</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>imageAlt</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>imagePosition</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;top&quot;</code></td></tr><tr><td><code>actionLabel</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>actionHref</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>headerActions</code></td><td><code>string</code></td><td>Optional</td><td><code>[]</code></td></tr><tr><td><code>navigation</code></td><td><code>string</code></td><td>Optional</td><td><code>[]</code></td></tr><tr><td><code>activeNav</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>mobileNavigation</code></td><td><code>boolean</code></td><td>Optional</td><td><code>false</code></td></tr><tr><td><code>alertTitle</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>alertDescription</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>empty</code></td><td><code>boolean</code></td><td>Optional</td><td><code>false</code></td></tr><tr><td><code>emptyTitle</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;No data to show&quot;</code></td></tr><tr><td><code>emptyIcon</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;icon-[lucide--inbox]&quot;</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>size</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;md&quot;</code></td></tr><tr><td><code>color</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;primary&quot;</code></td></tr><tr><td><code>variant</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;default&quot;</code></td></tr><tr><td><code>layout</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;vertical&quot;</code></td></tr><tr><td><code>align</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;left&quot;</code></td></tr><tr><td><code>hover</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;none&quot;</code></td></tr><tr><td><code>scrollable</code></td><td><code>boolean</code></td><td>Optional</td><td><code>false</code></td></tr><tr><td><code>maxHeight</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;18rem&quot;</code></td></tr><tr><td><code>dismissible</code></td><td><code>boolean</code></td><td>Optional</td><td><code>false</code></td></tr><tr><td><code>ariaLabel</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>class</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr></tbody></table></div></section><section id="slots"><h2>Slots</h2><ul><li><code>default</code></li></ul></section><section id="events"><h2>Events</h2><ul><li><code>click</code></li><li><code>action</code></li><li><code>navigate</code></li><li><code>dismiss</code></li><li><code>load</code></li><li><code>error</code></li></ul></section><section id="source"><h2>Source contract</h2><p>Installed source: <code>components/card.wrn</code></p><pre data-language="wrn"><code>component Card &#123;
props &#123;
@event click = function
@event action = function
@event navigate = function
@event dismiss = function
@event load = function
@event error = function
title = &quot;Card title&quot;
subtitle = &quot;&quot;
description = &quot;&quot;
header = &quot;&quot;
footer = &quot;&quot;
imageSrc = &quot;&quot;
imageAlt = &quot;&quot;
imagePosition = &quot;top&quot;
actionLabel = &quot;&quot;
actionHref = &quot;&quot;
headerActions = []
navigation = []
activeNav = &quot;&quot;
mobileNavigation = false
alertTitle = &quot;&quot;
alertDescription = &quot;&quot;
empty = false
emptyTitle = &quot;No data to show&quot;
emptyIcon = &quot;icon-[lucide--inbox]&quot;
items = []
size = &quot;md&quot;
color = &quot;primary&quot;
variant = &quot;default&quot;
layout = &quot;vertical&quot;
align = &quot;left&quot;
hover = &quot;none&quot;
scrollable = false
maxHeight = &quot;18rem&quot;
dismissible = false
ariaLabel = &quot;&quot;
class = &quot;&quot;
&#125;
state visible = true
state selectedNav = activeNav
functions &#123;
function chooseNavigation(item, index) &#123;
previousValue = selectedNav
selectedNav = item.value || item.label
$emit(&quot;navigate&quot;, &#123;
value: selectedNav,
previousValue: previousValue,
item: item,
index: index
&#125;)
&#125;
function chooseMobileNavigation(sourceEvent) &#123;
previousValue = selectedNav
selectedNav = sourceEvent.target.value
$emit(&quot;navigate&quot;, &#123;
value: selectedNav,
previousValue: previousValue
&#125;)
&#125;
function chooseAction(action, index) &#123;
$emit(&quot;action&quot;, &#123;
action: action,
index: index
&#125;)
&#125;
function dismissCard(sourceEvent) &#123;
panel = sourceEvent.currentTarget.closest(&quot;.wire-next__card-panel&quot;)
if (panel) &#123;
panel.setAttribute(&quot;hidden&quot;, &quot;&quot;)
&#125;
visible = false
$emit(&quot;dismiss&quot;, &#123;
title: title
&#125;)
&#125;
&#125;
view &#123;
&lt;section
&#123;...attrs&#125;
class=&quot;wire-next wire-next--card &#123;class&#125;&quot;
data-size=&quot;&#123;size&#125;&quot;
data-color=&quot;&#123;color&#125;&quot;
data-variant=&quot;&#123;variant&#125;&quot;
data-layout=&quot;&#123;layout&#125;&quot;
data-align=&quot;&#123;align&#125;&quot;
data-hover=&quot;&#123;hover&#125;&quot;
data-image-position=&quot;&#123;imagePosition&#125;&quot;
data-group=&quot;&#123;items.length &gt; 0&#125;&quot;
aria-label=&quot;&#123;ariaLabel || title&#125;&quot;
&gt;
&#123;#if items.length &gt; 0&#125;
&lt;div class=&quot;wire-next__card-group&quot;&gt;
&#123;#each items as item&#125;
&lt;article class=&quot;wire-next__card-panel&quot;&gt;
&#123;#if item.imageSrc&#125;
&lt;div class=&quot;wire-next__card-media&quot;&gt;
&lt;img src=&quot;&#123;item.imageSrc&#125;&quot; alt=&quot;&#123;item.imageAlt || ''&#125;&quot; loading=&quot;lazy&quot; /&gt;
&lt;/div&gt;
&#123;/if&#125;
&lt;div class=&quot;wire-next__card-body&quot;&gt;
&#123;#if item.title&#125;&lt;h3&gt;&#123;item.title&#125;&lt;/h3&gt;&#123;/if&#125;
&#123;#if item.description&#125;&lt;p&gt;&#123;item.description&#125;&lt;/p&gt;&#123;/if&#125;
&lt;/div&gt;
&#123;#if item.footer&#125;&lt;footer class=&quot;wire-next__card-footer&quot;&gt;&#123;item.footer&#125;&lt;/footer&gt;&#123;/if&#125;
&lt;/article&gt;
&#123;/each&#125;
&lt;/div&gt;
&#123;:else if visible&#125;
&lt;article class=&quot;wire-next__card-panel&quot;&gt;
&#123;#if imagePosition === &quot;overlay&quot; &amp;&amp; imageSrc&#125;
&lt;div class=&quot;wire-next__card-media wire-next__card-media--overlay&quot;&gt;
&lt;img
src=&quot;&#123;imageSrc&#125;&quot;
alt=&quot;&#123;imageAlt&#125;&quot;
loading=&quot;lazy&quot;
@load=&quot;$emit('load', &#123; src: imageSrc &#125;)&quot;
@error=&quot;$emit('error', &#123; src: imageSrc &#125;)&quot;
/&gt;
&lt;div class=&quot;wire-next__card-overlay&quot;&gt;
&#123;#if title&#125;&lt;h3&gt;&#123;title&#125;&lt;/h3&gt;&#123;/if&#125;
&#123;#if subtitle&#125;&lt;span class=&quot;wire-next__card-subtitle&quot;&gt;&#123;subtitle&#125;&lt;/span&gt;&#123;/if&#125;
&#123;#if description&#125;&lt;p&gt;&#123;description&#125;&lt;/p&gt;&#123;/if&#125;
&#123;#if footer&#125;&lt;small&gt;&#123;footer&#125;&lt;/small&gt;&#123;/if&#125;
&lt;/div&gt;
&lt;/div&gt;
&#123;:else&#125;
&#123;#if header || headerActions.length &gt; 0 || dismissible&#125;
&lt;header class=&quot;wire-next__card-header&quot;&gt;
&lt;span&gt;&#123;header&#125;&lt;/span&gt;
&#123;#if headerActions.length &gt; 0 || dismissible&#125;
&lt;span class=&quot;wire-next__card-header-actions&quot;&gt;
&#123;#each headerActions as action, index&#125;
&lt;button
type=&quot;button&quot;
aria-label=&quot;&#123;action.ariaLabel || action.label&#125;&quot;
title=&quot;&#123;action.label&#125;&quot;
@click=&quot;chooseAction(action, index)&quot;
&gt;
&#123;#if action.icon&#125;&lt;span class=&quot;&#123;action.icon&#125;&quot; aria-hidden=&quot;true&quot;&gt;
&lt;/span&gt;&#123;/if&#125;
&#123;#if !action.icon&#125;&lt;span&gt;&#123;action.label&#125;&lt;/span&gt;&#123;/if&#125;
&lt;/button&gt;
&#123;/each&#125;
&#123;#if dismissible&#125;
&lt;button type=&quot;button&quot; aria-label=&quot;Close card&quot; @click=&quot;dismissCard(event)&quot;&gt;
&lt;span class=&quot;icon-[lucide--x]&quot; aria-hidden=&quot;true&quot;&gt;
&lt;/span&gt;
&lt;/button&gt;
&#123;/if&#125;
&lt;/span&gt;
&#123;/if&#125;
&lt;/header&gt;
&#123;/if&#125;
&#123;#if navigation.length &gt; 0&#125;
&lt;nav class=&quot;wire-next__card-navigation&quot; aria-label=&quot;&#123;ariaLabel || title&#125;&quot;&gt;
&lt;div class=&quot;wire-next__card-tabs&quot;&gt;
&#123;#each navigation as item, index&#125;
&lt;button
type=&quot;button&quot;
data-active=&quot;&#123;selectedNav === (item.value || item.label)&#125;&quot;
aria-current=&quot;&#123;selectedNav === (item.value || item.label) ? 'page' : ''&#125;&quot;
@click=&quot;chooseNavigation(item, index)&quot;
&gt;
&#123;item.label&#125;
&lt;/button&gt;
&#123;/each&#125;
&lt;/div&gt;
&#123;#if mobileNavigation&#125;
&lt;select
class=&quot;wire-next__card-navigation-select&quot;
aria-label=&quot;&#123;ariaLabel || title&#125;&quot;
value=&quot;&#123;selectedNav&#125;&quot;
@change=&quot;chooseMobileNavigation(event)&quot;
&gt;
&#123;#each navigation as item&#125;
&lt;option
value=&quot;&#123;item.value || item.label&#125;&quot;
selected=&quot;&#123;selectedNav === (item.value || item.label)&#125;&quot;
&gt;
&#123;item.label&#125;
&lt;/option&gt;
&#123;/each&#125;
&lt;/select&gt;
&#123;/if&#125;
&lt;/nav&gt;
&#123;/if&#125;
&#123;#if imageSrc &amp;&amp; imagePosition !== &quot;bottom&quot;&#125;
&lt;div class=&quot;wire-next__card-media&quot;&gt;
&lt;img
src=&quot;&#123;imageSrc&#125;&quot;
alt=&quot;&#123;imageAlt&#125;&quot;
loading=&quot;lazy&quot;
@load=&quot;$emit('load', &#123; src: imageSrc &#125;)&quot;
@error=&quot;$emit('error', &#123; src: imageSrc &#125;)&quot;
/&gt;
&lt;/div&gt;
&#123;/if&#125;
&#123;#if alertTitle || alertDescription&#125;
&lt;aside class=&quot;wire-next__card-alert&quot; role=&quot;status&quot;&gt;
&#123;#if alertTitle&#125;&lt;strong&gt;&#123;alertTitle&#125;&lt;/strong&gt;&#123;/if&#125;
&#123;#if alertDescription&#125;&lt;span&gt;&#123;alertDescription&#125;&lt;/span&gt;&#123;/if&#125;
&lt;/aside&gt;
&#123;/if&#125;
&lt;div
class=&quot;wire-next__card-body&quot;
data-scrollable=&quot;&#123;scrollable&#125;&quot;
style=&quot;--wire-card-max-height: &#123;maxHeight&#125;&quot;
&gt;
&#123;#if empty&#125;
&lt;div class=&quot;wire-next__card-empty&quot;&gt;
&lt;span class=&quot;&#123;emptyIcon&#125;&quot; aria-hidden=&quot;true&quot;&gt;
&lt;/span&gt;
&lt;strong&gt;&#123;emptyTitle&#125;&lt;/strong&gt;
&lt;/div&gt;
&#123;:else&#125;
&#123;#if title&#125;&lt;h3&gt;&#123;title&#125;&lt;/h3&gt;&#123;/if&#125;
&#123;#if subtitle&#125;&lt;span class=&quot;wire-next__card-subtitle&quot;&gt;&#123;subtitle&#125;&lt;/span&gt;&#123;/if&#125;
&#123;#if description&#125;&lt;p&gt;&#123;description&#125;&lt;/p&gt;&#123;/if&#125;
&lt;slot /&gt;
&#123;#if actionLabel&#125;
&lt;a
class=&quot;wire-next__card-action&quot;
href=&quot;&#123;actionHref || '#'&#125;&quot;
@click=&quot;$emit('action', &#123; label: actionLabel, href: actionHref &#125;)&quot;
&gt;
&#123;actionLabel&#125;&lt;span class=&quot;icon-[lucide--chevron-right]&quot; aria-hidden=&quot;true&quot;&gt;
&lt;/span&gt;
&lt;/a&gt;
&#123;/if&#125;
&#123;/if&#125;
&lt;/div&gt;
&#123;#if footer&#125;&lt;footer class=&quot;wire-next__card-footer&quot;&gt;&#123;footer&#125;&lt;/footer&gt;&#123;/if&#125;
&#123;#if imageSrc &amp;&amp; imagePosition === &quot;bottom&quot;&#125;
&lt;div class=&quot;wire-next__card-media&quot;&gt;
&lt;img
src=&quot;&#123;imageSrc&#125;&quot;
alt=&quot;&#123;imageAlt&#125;&quot;
loading=&quot;lazy&quot;
@load=&quot;$emit('load', &#123; src: imageSrc &#125;)&quot;
@error=&quot;$emit('error', &#123; src: imageSrc &#125;)&quot;
/&gt;
&lt;/div&gt;
&#123;/if&#125;
&#123;/if&#125;
&lt;/article&gt;
&#123;/if&#125;
&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.5.0</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>
}
}