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

149 lines
9.8 KiB
Plaintext

page AvatarGroupcomponent {
seo {
title = "AvatarGroup component"
description = "Theme-aware, responsive avatar group 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">AvatarGroup</span></nav><section class="doc-intro"><span class="eyebrow">base component</span><h1>AvatarGroup</h1><p>Theme-aware, responsive avatar group component.</p><div class="doc-meta"><span>@wrnexus/ui 0.5.0</span><span>12 props</span><span>0 slots</span><span>1 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;AvatarGroup
items=&quot;[]&quot;
size=&quot;md&quot;
color=&quot;primary&quot;
variant=&quot;solid&quot;
shape=&quot;circle&quot;
/&gt;</code></pre><p>Legacy mount name: <code>data-component=&quot;AvatarGroup&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>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;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>layout</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;stack&quot;</code></td></tr><tr><td><code>maxVisible</code></td><td><code>number</code></td><td>Optional</td><td><code>4</code></td></tr><tr><td><code>columns</code></td><td><code>number</code></td><td>Optional</td><td><code>3</code></td></tr><tr><td><code>borderColor</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>showTooltips</code></td><td><code>boolean</code></td><td>Optional</td><td><code>true</code></td></tr><tr><td><code>overflowLabel</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;Show remaining members&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>overflow</code></li></ul></section><section id="source"><h2>Source contract</h2><p>Installed source: <code>components/AvatarGroup.wrn</code></p><pre data-language="wrn"><code>component AvatarGroup &#123;
props &#123;
items = []
size = &quot;md&quot;
color = &quot;primary&quot;
variant = &quot;solid&quot;
shape = &quot;circle&quot;
layout = &quot;stack&quot;
maxVisible = 4
columns = 3
borderColor = &quot;&quot;
showTooltips = true
overflowLabel = &quot;Show remaining members&quot;
class = &quot;&quot;
@event overflow = function
&#125;
state overflowOpen = false
functions &#123;
function visibleMembers() &#123;
return items.slice(0, Number(maxVisible))
&#125;
function hiddenMembers() &#123;
return items.slice(Number(maxVisible))
&#125;
function toggleOverflow(sourceEvent, root, customEvent) &#123;
overflowOpen = !overflowOpen
root = sourceEvent.currentTarget.closest(&quot;[data-wrn-avatar-group]&quot;)
customEvent = document.createEvent(&quot;CustomEvent&quot;)
customEvent.initCustomEvent(&quot;overflow&quot;, true, false, &#123;
component: &quot;AvatarGroup&quot;,
open: overflowOpen,
hiddenCount: hiddenMembers().length
&#125;)
root.dispatchEvent(customEvent)
&#125;
&#125;
view &#123;
&lt;div
&#123;...attrs&#125;
class=&quot;wire-next wire-next--avatar-group &#123;class&#125;&quot;
data-wrn-avatar-group
data-layout=&quot;&#123;layout&#125;&quot;
data-shape=&quot;&#123;shape&#125;&quot;
data-size=&quot;&#123;size&#125;&quot;
style=&quot;--wire-avatar-group-columns:&#123;columns&#125;; --wire-avatar-group-ring:&#123;borderColor || 'var(--wire-color-bg)'&#125;&quot;
role=&quot;group&quot;
aria-label=&quot;Avatar group&quot;
&gt;
&lt;div class=&quot;wire-next__avatar-group-members&quot;&gt;
&#123;#each visibleMembers() as item&#125;
&lt;span
class=&quot;wire-next__avatar-group-member&quot;
data-size=&quot;&#123;item.size || size&#125;&quot;
data-shape=&quot;&#123;item.shape || shape&#125;&quot;
data-color=&quot;&#123;item.color || color&#125;&quot;
data-variant=&quot;&#123;item.variant || variant&#125;&quot;
tabindex=&quot;&#123;showTooltips &amp;&amp; (item.tooltip || item.name) ? '0' : '-1'&#125;&quot;
aria-label=&quot;&#123;item.name || item.alt || item.initials || 'Group member'&#125;&quot;
&gt;
&lt;span class=&quot;wire-next__avatar-group-avatar&quot;&gt;
&#123;#if item.src&#125;
&lt;img src=&quot;&#123;item.src&#125;&quot; alt=&quot;&#123;item.alt || item.name || ''&#125;&quot; loading=&quot;lazy&quot; /&gt;
&#123;:else if item.initials&#125;
&lt;span aria-hidden=&quot;true&quot;&gt;&#123;item.initials&#125;&lt;/span&gt;
&#123;:else&#125;
&lt;span class=&quot;icon-[lucide--user-round]&quot; aria-hidden=&quot;true&quot;&gt;
&lt;/span&gt;
&#123;/if&#125;
&lt;/span&gt;
&#123;#if showTooltips &amp;&amp; (item.tooltip || item.name)&#125;
&lt;span class=&quot;wire-next__avatar-group-tooltip&quot; role=&quot;tooltip&quot;&gt;
&#123;item.tooltip || item.name&#125;
&lt;/span&gt;
&#123;/if&#125;
&lt;/span&gt;
&#123;/each&#125;
&#123;#if hiddenMembers().length &gt; 0&#125;
&lt;span class=&quot;wire-next__avatar-group-overflow&quot;&gt;
&lt;button
type=&quot;button&quot;
class=&quot;wire-next__avatar-group-overflow-button&quot;
aria-label=&quot;&#123;overflowLabel&#125;&quot;
aria-expanded=&quot;&#123;overflowOpen ? 'true' : 'false'&#125;&quot;
@click=&quot;toggleOverflow(event)&quot;
&gt;
+&#123;hiddenMembers().length&#125;
&lt;/button&gt;
&lt;span
class=&quot;wire-next__avatar-group-menu&quot;
role=&quot;menu&quot;
data-show=&quot;overflowOpen&quot;
aria-hidden=&quot;&#123;overflowOpen ? 'false' : 'true'&#125;&quot;
&gt;
&#123;#each hiddenMembers() as item&#125;
&lt;span class=&quot;wire-next__avatar-group-menu-item&quot; role=&quot;menuitem&quot;&gt;
&lt;span class=&quot;wire-next__avatar-group-menu-avatar&quot;&gt;
&#123;#if item.src&#125;
&lt;img src=&quot;&#123;item.src&#125;&quot; alt=&quot;&quot; loading=&quot;lazy&quot; /&gt;
&#123;:else&#125;
&lt;span&gt;&#123;item.initials || '?'&#125;&lt;/span&gt;
&#123;/if&#125;
&lt;/span&gt;
&lt;span&gt;&#123;item.name || item.alt || item.initials || 'Team member'&#125;&lt;/span&gt;
&lt;/span&gt;
&#123;/each&#125;
&lt;/span&gt;
&lt;/span&gt;
&#123;/if&#125;
&lt;/div&gt;
&lt;/div&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>
}
}