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

118 lines
8.9 KiB
Plaintext

page Avatarcomponent {
seo {
title = "Avatar component"
description = "Theme-aware, responsive avatar 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">Avatar</span></nav><section class="doc-intro"><span class="eyebrow">base component</span><h1>Avatar</h1><p>Theme-aware, responsive avatar component.</p><div class="doc-meta"><span>@wrnexus/ui 0.5.0</span><span>18 props</span><span>0 slots</span><span>3 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;Avatar
src=&quot;src&quot;
alt=&quot;alt&quot;
initials=&quot;initials&quot;
size=&quot;md&quot;
color=&quot;primary&quot;
/&gt;</code></pre><p>Legacy mount name: <code>data-component=&quot;Avatar&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>src</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>alt</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>initials</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</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;solid&quot;</code></td></tr><tr><td><code>shape</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;circle&quot;</code></td></tr><tr><td><code>status</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>statusLabel</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>statusPosition</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;bottom&quot;</code></td></tr><tr><td><code>badge</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>badgeIcon</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>badgeLabel</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>tooltip</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>name</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>loading</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;lazy&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><p>This component does not declare a slot.</p></section><section id="events"><h2>Events</h2><ul><li><code>load</code></li><li><code>error</code></li><li><code>click</code></li></ul></section><section id="source"><h2>Source contract</h2><p>Installed source: <code>components/avatar.wrn</code></p><pre data-language="wrn"><code>component Avatar &#123;
props &#123;
@event load = function
@event error = function
@event click = function
src = &quot;&quot;
alt = &quot;&quot;
initials = &quot;&quot;
size = &quot;md&quot;
color = &quot;primary&quot;
variant = &quot;solid&quot;
shape = &quot;circle&quot;
status = &quot;&quot;
statusLabel = &quot;&quot;
statusPosition = &quot;bottom&quot;
badge = &quot;&quot;
badgeIcon = &quot;&quot;
badgeLabel = &quot;&quot;
tooltip = &quot;&quot;
name = &quot;&quot;
description = &quot;&quot;
loading = &quot;lazy&quot;
class = &quot;&quot;
&#125;
view &#123;
&lt;span
&#123;...attrs&#125;
class=&quot;wire-next wire-next--avatar &#123;description ? 'wire-next--avatar-media' : ''&#125; &#123;class&#125;&quot;
data-wrn-avatar
&gt;
&lt;span
class=&quot;wire-next__avatar-wrap&quot;
data-shape=&quot;&#123;shape&#125;&quot;
data-size=&quot;&#123;size&#125;&quot;
data-color=&quot;&#123;color&#125;&quot;
data-variant=&quot;&#123;variant&#125;&quot;
data-status-position=&quot;&#123;statusPosition&#125;&quot;
tabindex=&quot;&#123;tooltip ? '0' : '-1'&#125;&quot;
aria-label=&quot;&#123;tooltip || name || alt || initials || 'Avatar'&#125;&quot;
&gt;
&lt;span class=&quot;wire-next__avatar&quot;&gt;
&#123;#if src&#125;
&lt;img src=&quot;&#123;src&#125;&quot; alt=&quot;&#123;alt || name&#125;&quot; loading=&quot;&#123;loading&#125;&quot; /&gt;
&#123;:else if initials&#125;
&lt;span class=&quot;wire-next__avatar-initials&quot; aria-hidden=&quot;true&quot;&gt;&#123;initials&#125;&lt;/span&gt;
&#123;:else&#125;
&lt;span class=&quot;wire-next__avatar-placeholder icon-[lucide--user-round]&quot; aria-hidden=&quot;true&quot;&gt;
&lt;/span&gt;
&#123;/if&#125;
&lt;/span&gt;
&#123;#if status&#125;
&lt;span
class=&quot;wire-next__avatar-status&quot;
data-status=&quot;&#123;status&#125;&quot;
title=&quot;&#123;statusLabel || status&#125;&quot;
aria-label=&quot;&#123;statusLabel || status&#125;&quot;
&gt;
&lt;/span&gt;
&#123;/if&#125;
&#123;#if badgeIcon&#125;
&lt;span class=&quot;wire-next__avatar-badge&quot; aria-label=&quot;&#123;badgeLabel || 'Linked account'&#125;&quot;&gt;
&lt;span class=&quot;&#123;badgeIcon&#125;&quot; aria-hidden=&quot;true&quot;&gt;
&lt;/span&gt;
&lt;/span&gt;
&#123;:else if badge&#125;
&lt;span class=&quot;wire-next__avatar-badge wire-next__avatar-badge--text&quot; aria-label=&quot;&#123;badgeLabel || badge&#125;&quot;&gt;
&#123;badge&#125;
&lt;/span&gt;
&#123;/if&#125;
&#123;#if tooltip&#125;
&lt;span class=&quot;wire-next__avatar-tooltip&quot; role=&quot;tooltip&quot;&gt;&#123;tooltip&#125;&lt;/span&gt;
&#123;/if&#125;
&lt;/span&gt;
&#123;#if description&#125;
&lt;span class=&quot;wire-next__avatar-copy&quot;&gt;
&lt;strong&gt;&#123;name || alt || initials&#125;&lt;/strong&gt;
&lt;span&gt;&#123;description&#125;&lt;/span&gt;
&lt;/span&gt;
&#123;/if&#125;
&lt;/span&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>
}
}