355 lines
24 KiB
Plaintext
355 lines
24 KiB
Plaintext
// Generated by scripts/generate-showcase.mjs. Do not edit directly.
|
|
page AvatarGroupDetail {
|
|
layout = "showcase"
|
|
state playground_items = ctx.url.searchParams.get("pg_items") ?? "[\n {\n \"src\": \"/avatar-example.svg\",\n \"name\": \"Mark Wanner\",\n \"alt\": \"Mark Wanner\"\n },\n {\n \"src\": \"/avatar-example-2.svg\",\n \"name\": \"Maria Guan\",\n \"alt\": \"Maria Guan\"\n },\n {\n \"src\": \"/avatar-example-3.svg\",\n \"name\": \"Amil Evara\",\n \"alt\": \"Amil Evara\"\n },\n {\n \"initials\": \"EE\",\n \"name\": \"Ebele Egbuna\",\n \"color\": \"info\"\n }\n]"
|
|
state playground_size = ctx.url.searchParams.get("pg_size") ?? "lg"
|
|
state playground_color = ctx.url.searchParams.get("pg_color") ?? "primary"
|
|
state playground_variant = ctx.url.searchParams.get("pg_variant") ?? "solid"
|
|
state playground_shape = ctx.url.searchParams.get("pg_shape") ?? "circle"
|
|
state playground_layout = ctx.url.searchParams.get("pg_layout") ?? "stack"
|
|
state playground_maxVisible = ctx.url.searchParams.get("pg_maxVisible") ?? "4"
|
|
state playground_columns = ctx.url.searchParams.get("pg_columns") ?? "3"
|
|
state playground_borderColor = ctx.url.searchParams.get("pg_borderColor") ?? ""
|
|
state playground_showTooltips = ctx.url.searchParams.get("pg_showTooltips") ?? "true"
|
|
state playground_overflowLabel = ctx.url.searchParams.get("pg_overflowLabel") ?? "Show remaining members"
|
|
state playground_class = ctx.url.searchParams.get("pg_class") ?? ""
|
|
seo {
|
|
title = "Avatar Group"
|
|
description = "Theme-aware, responsive avatar group component."
|
|
}
|
|
view {
|
|
<nav class="docs-breadcrumbs" aria-label="Breadcrumb">
|
|
<a href="/">Components</a><span aria-hidden="true">/</span><a href="/base">Base</a><span aria-hidden="true">/</span><span>Avatar Group</span>
|
|
</nav>
|
|
<header class="detail-hero">
|
|
<div class="detail-hero-copy">
|
|
<span class="showcase-eyebrow">Base component</span>
|
|
<h1>Avatar Group</h1>
|
|
<p>Theme-aware, responsive avatar group component.</p>
|
|
<div class="detail-badges"><span>12 props</span><span>0 slots</span><span>1 events</span><span>Theme ready</span><span>Responsive</span></div>
|
|
</div>
|
|
<div class="detail-hero-icon"><span class="icon-[lucide--component] size-10" aria-hidden="true"></span></div>
|
|
</header>
|
|
<section id="playground" class="detail-section playground-section" data-playground data-playground-component="AvatarGroup" data-playground-public-tag="true" data-playground-has-slot="false">
|
|
<div class="detail-section-heading"><span>Interactive playground</span><h2>Configure Avatar Group</h2><p>Change any prop and inspect the server-rendered component immediately.</p></div>
|
|
<div class="playground-workbench">
|
|
<div class="playground-preview">
|
|
<div class="demo-browser-chrome"><span></span><span></span><span></span><small>Live preview</small></div>
|
|
<div class="playground-preview-source" data-playground-preview><div data-component="AvatarGroup" items="{playground_items}" size="{playground_size}" color="{playground_color}" variant="{playground_variant}" shape="{playground_shape}" layout="{playground_layout}" maxVisible="{playground_maxVisible}" columns="{playground_columns}" borderColor="{playground_borderColor}" showTooltips="{playground_showTooltips}" overflowLabel="{playground_overflowLabel}" class="{playground_class}"></div></div>
|
|
<section class="playground-code" aria-label="Current component code">
|
|
<header><span><span class="icon-[lucide--code-2] size-4" aria-hidden="true"></span>Component code</span><button type="button" data-playground-copy><span class="icon-[lucide--copy] size-4" aria-hidden="true"></span>Copy</button></header>
|
|
<pre><code data-playground-code><AvatarGroup
|
|
items='[
|
|
{
|
|
"src": "/avatar-example.svg",
|
|
"name": "Mark Wanner",
|
|
"alt": "Mark Wanner"
|
|
},
|
|
{
|
|
"src": "/avatar-example-2.svg",
|
|
"name": "Maria Guan",
|
|
"alt": "Maria Guan"
|
|
},
|
|
{
|
|
"src": "/avatar-example-3.svg",
|
|
"name": "Amil Evara",
|
|
"alt": "Amil Evara"
|
|
},
|
|
{
|
|
"initials": "EE",
|
|
"name": "Ebele Egbuna",
|
|
"color": "info"
|
|
}
|
|
]'
|
|
size="lg"
|
|
/></code></pre>
|
|
</section>
|
|
<div class="playground-status" data-playground-status aria-live="polite"></div>
|
|
</div>
|
|
<form class="playground-controls" data-playground-form>
|
|
<header><div><span>Component props</span><strong>12 controls</strong></div><button type="reset"><span class="icon-[lucide--rotate-ccw] size-4" aria-hidden="true"></span>Reset</button></header>
|
|
<div class="playground-fields"><label class="playground-field" for="playground-avatar-group-items"><span><strong>items</strong><small>string</small></span><textarea id="playground-avatar-group-items" name="pg_items" rows="5" spellcheck="false" data-playground-json>[
|
|
{
|
|
"src": "/avatar-example.svg",
|
|
"name": "Mark Wanner",
|
|
"alt": "Mark Wanner"
|
|
},
|
|
{
|
|
"src": "/avatar-example-2.svg",
|
|
"name": "Maria Guan",
|
|
"alt": "Maria Guan"
|
|
},
|
|
{
|
|
"src": "/avatar-example-3.svg",
|
|
"name": "Amil Evara",
|
|
"alt": "Amil Evara"
|
|
},
|
|
{
|
|
"initials": "EE",
|
|
"name": "Ebele Egbuna",
|
|
"color": "info"
|
|
}
|
|
]</textarea><em data-playground-error></em></label><label class="playground-field" for="playground-avatar-group-size"><span><strong>size</strong><small>string</small></span><select id="playground-avatar-group-size" name="pg_size"><option value="lg" selected>lg</option><option value="md">md</option><option value="default">default</option><option value="xs">xs</option><option value="sm">sm</option><option value="xl">xl</option><option value="icon">icon</option><option value="icon-xs">icon-xs</option><option value="icon-sm">icon-sm</option><option value="icon-lg">icon-lg</option></select></label><label class="playground-field" for="playground-avatar-group-color"><span><strong>color</strong><small>string</small></span><select id="playground-avatar-group-color" name="pg_color"><option value="primary" selected>primary</option><option value="secondary">secondary</option><option value="success">success</option><option value="warning">warning</option><option value="danger">danger</option><option value="info">info</option></select></label><label class="playground-field" for="playground-avatar-group-variant"><span><strong>variant</strong><small>string</small></span><select id="playground-avatar-group-variant" name="pg_variant"><option value="solid" selected>solid</option><option value="default">default</option><option value="outline">outline</option><option value="secondary">secondary</option><option value="ghost">ghost</option><option value="destructive">destructive</option><option value="link">link</option></select></label><label class="playground-field" for="playground-avatar-group-shape"><span><strong>shape</strong><small>string</small></span><input id="playground-avatar-group-shape" name="pg_shape" type="text" value="circle" /></label><label class="playground-field" for="playground-avatar-group-layout"><span><strong>layout</strong><small>string</small></span><input id="playground-avatar-group-layout" name="pg_layout" type="text" value="stack" /></label><label class="playground-field" for="playground-avatar-group-maxVisible"><span><strong>max Visible</strong><small>number</small></span><input id="playground-avatar-group-maxVisible" name="pg_maxVisible" type="number" value="4" /></label><label class="playground-field" for="playground-avatar-group-columns"><span><strong>columns</strong><small>number</small></span><input id="playground-avatar-group-columns" name="pg_columns" type="number" value="3" /></label><label class="playground-field" for="playground-avatar-group-borderColor"><span><strong>border Color</strong><small>string</small></span><input id="playground-avatar-group-borderColor" name="pg_borderColor" type="text" value="" /></label><label class="playground-toggle" for="playground-avatar-group-showTooltips"><span><strong>show Tooltips</strong><small>boolean</small></span><input id="playground-avatar-group-showTooltips" name="pg_showTooltips" type="checkbox" value="true" checked data-playground-boolean /><i aria-hidden="true"></i></label><label class="playground-field" for="playground-avatar-group-overflowLabel"><span><strong>overflow Label</strong><small>string</small></span><input id="playground-avatar-group-overflowLabel" name="pg_overflowLabel" type="text" value="Show remaining members" /></label><label class="playground-field" for="playground-avatar-group-class"><span><strong>class</strong><small>string</small></span><input id="playground-avatar-group-class" name="pg_class" type="text" value="" /></label></div>
|
|
</form>
|
|
</div>
|
|
</section>
|
|
<div class="detail-layout">
|
|
<main class="detail-content">
|
|
<section class="detail-section"><div class="detail-section-heading"><span>Live examples</span><h2>Designed for real product surfaces</h2><p>Compare configurations and resize the browser to check responsive behavior.</p></div><div class="demo-list">
|
|
<article class="demo-case">
|
|
<header class="demo-case-header">
|
|
<div><span class="demo-case-eyebrow">Facepile</span><h2>Overlapping stack</h2><p>Overlap avatars with negative spacing to create a compact team facepile.</p></div>
|
|
<span class="demo-case-number">01</span>
|
|
</header>
|
|
<div class="demo-workbench">
|
|
<div id="avatar-group-demo-1" class="demo-canvas demo-canvas--1">
|
|
<div class="demo-browser-chrome"><span></span><span></span><span></span><small>Live preview</small></div>
|
|
<div class="demo-render"><div data-component="AvatarGroup" items="[{"src":"/avatar-example.svg","name":"Mark Wanner","alt":"Mark Wanner"},{"src":"/avatar-example-2.svg","name":"Maria Guan","alt":"Maria Guan"},{"src":"/avatar-example-3.svg","name":"Amil Evara","alt":"Amil Evara"},{"initials":"EE","name":"Ebele Egbuna","color":"info"}]" size="lg" color="primary" variant="solid" shape="circle" layout="stack" maxVisible="4"></div></div>
|
|
</div>
|
|
<section class="demo-code" aria-label="Overlapping stack usage">
|
|
<header><span><span class="icon-[lucide--code-2] size-4" aria-hidden="true"></span>Component usage</span><small>.wrn</small></header>
|
|
<pre><code><AvatarGroup
|
|
items='[
|
|
{
|
|
"src": "/avatar-example.svg",
|
|
"name": "Mark Wanner",
|
|
"alt": "Mark Wanner"
|
|
},
|
|
{
|
|
"src": "/avatar-example-2.svg",
|
|
"name": "Maria Guan",
|
|
"alt": "Maria Guan"
|
|
},
|
|
{
|
|
"src": "/avatar-example-3.svg",
|
|
"name": "Amil Evara",
|
|
"alt": "Amil Evara"
|
|
},
|
|
{
|
|
"initials": "EE",
|
|
"name": "Ebele Egbuna",
|
|
"color": "info"
|
|
}
|
|
]'
|
|
size="lg"
|
|
/></code></pre>
|
|
</section>
|
|
</div>
|
|
</article>
|
|
<article class="demo-case">
|
|
<header class="demo-case-header">
|
|
<div><span class="demo-case-eyebrow">Layout</span><h2>Grid layout</h2><p>Arrange members in a grid with equal spacing and a clear overflow count.</p></div>
|
|
<span class="demo-case-number">02</span>
|
|
</header>
|
|
<div class="demo-workbench">
|
|
<div id="avatar-group-demo-2" class="demo-canvas demo-canvas--2">
|
|
<div class="demo-browser-chrome"><span></span><span></span><span></span><small>Live preview</small></div>
|
|
<div class="demo-render"><div data-component="AvatarGroup" items="[{"src":"/avatar-example.svg","name":"Mark Wanner","alt":"Mark Wanner"},{"src":"/avatar-example-2.svg","name":"Maria Guan","alt":"Maria Guan"},{"src":"/avatar-example-3.svg","name":"Amil Evara","alt":"Amil Evara"},{"initials":"EE","name":"Ebele Egbuna","color":"info"},{"initials":"CL","name":"Chris Lynch","color":"success"},{"initials":"NS","name":"Nora Singh","color":"warning"},{"initials":"JR","name":"Jon Rivera","color":"danger"},{"initials":"AK","name":"Amina Khan","color":"secondary"}]" size="md" color="primary" variant="solid" shape="circle" layout="grid" maxVisible="7" columns="3"></div></div>
|
|
</div>
|
|
<section class="demo-code" aria-label="Grid layout usage">
|
|
<header><span><span class="icon-[lucide--code-2] size-4" aria-hidden="true"></span>Component usage</span><small>.wrn</small></header>
|
|
<pre><code><AvatarGroup
|
|
items='[
|
|
{
|
|
"src": "/avatar-example.svg",
|
|
"name": "Mark Wanner",
|
|
"alt": "Mark Wanner"
|
|
},
|
|
{
|
|
"src": "/avatar-example-2.svg",
|
|
"name": "Maria Guan",
|
|
"alt": "Maria Guan"
|
|
},
|
|
{
|
|
"src": "/avatar-example-3.svg",
|
|
"name": "Amil Evara",
|
|
"alt": "Amil Evara"
|
|
},
|
|
{
|
|
"initials": "EE",
|
|
"name": "Ebele Egbuna",
|
|
"color": "info"
|
|
},
|
|
{
|
|
"initials": "CL",
|
|
"name": "Chris Lynch",
|
|
"color": "success"
|
|
},
|
|
{
|
|
"initials": "NS",
|
|
"name": "Nora Singh",
|
|
"color": "warning"
|
|
},
|
|
{
|
|
"initials": "JR",
|
|
"name": "Jon Rivera",
|
|
"color": "danger"
|
|
},
|
|
{
|
|
"initials": "AK",
|
|
"name": "Amina Khan",
|
|
"color": "secondary"
|
|
}
|
|
]'
|
|
layout="grid"
|
|
maxVisible="7"
|
|
/></code></pre>
|
|
</section>
|
|
</div>
|
|
</article>
|
|
<article class="demo-case">
|
|
<header class="demo-case-header">
|
|
<div><span class="demo-case-eyebrow">Border</span><h2>Custom border color</h2><p>Change the ring color so stacked groups remain distinct on different surfaces.</p></div>
|
|
<span class="demo-case-number">03</span>
|
|
</header>
|
|
<div class="demo-workbench">
|
|
<div id="avatar-group-demo-3" class="demo-canvas demo-canvas--3">
|
|
<div class="demo-browser-chrome"><span></span><span></span><span></span><small>Live preview</small></div>
|
|
<div class="demo-render"><div data-component="AvatarGroup" items="[{"src":"/avatar-example.svg","name":"Mark Wanner","alt":"Mark Wanner"},{"src":"/avatar-example-2.svg","name":"Maria Guan","alt":"Maria Guan"},{"src":"/avatar-example-3.svg","name":"Amil Evara","alt":"Amil Evara"},{"initials":"EE","name":"Ebele Egbuna","color":"info"}]" size="md" color="primary" variant="solid" shape="circle" layout="stack" maxVisible="4" borderColor="#2583ff"></div></div>
|
|
</div>
|
|
<section class="demo-code" aria-label="Custom border color usage">
|
|
<header><span><span class="icon-[lucide--code-2] size-4" aria-hidden="true"></span>Component usage</span><small>.wrn</small></header>
|
|
<pre><code><AvatarGroup
|
|
items='[
|
|
{
|
|
"src": "/avatar-example.svg",
|
|
"name": "Mark Wanner",
|
|
"alt": "Mark Wanner"
|
|
},
|
|
{
|
|
"src": "/avatar-example-2.svg",
|
|
"name": "Maria Guan",
|
|
"alt": "Maria Guan"
|
|
},
|
|
{
|
|
"src": "/avatar-example-3.svg",
|
|
"name": "Amil Evara",
|
|
"alt": "Amil Evara"
|
|
},
|
|
{
|
|
"initials": "EE",
|
|
"name": "Ebele Egbuna",
|
|
"color": "info"
|
|
}
|
|
]'
|
|
borderColor="#2583ff"
|
|
/></code></pre>
|
|
</section>
|
|
</div>
|
|
</article>
|
|
<article class="demo-case">
|
|
<header class="demo-case-header">
|
|
<div><span class="demo-case-eyebrow">Tooltip</span><h2>Member tooltips</h2><p>Reveal each member's name on pointer hover or keyboard focus.</p></div>
|
|
<span class="demo-case-number">04</span>
|
|
</header>
|
|
<div class="demo-workbench">
|
|
<div id="avatar-group-demo-4" class="demo-canvas demo-canvas--4">
|
|
<div class="demo-browser-chrome"><span></span><span></span><span></span><small>Live preview</small></div>
|
|
<div class="demo-render"><div data-component="AvatarGroup" items="[{"src":"/avatar-example.svg","name":"Mark Wanner","alt":"Mark Wanner"},{"src":"/avatar-example-2.svg","name":"Maria Guan","alt":"Maria Guan"},{"src":"/avatar-example-3.svg","name":"Amil Evara","alt":"Amil Evara"},{"initials":"EE","name":"Ebele Egbuna","color":"info"}]" size="md" color="primary" variant="solid" shape="circle" layout="stack" maxVisible="4" showTooltips="true"></div></div>
|
|
</div>
|
|
<section class="demo-code" aria-label="Member tooltips usage">
|
|
<header><span><span class="icon-[lucide--code-2] size-4" aria-hidden="true"></span>Component usage</span><small>.wrn</small></header>
|
|
<pre><code><AvatarGroup
|
|
items='[
|
|
{
|
|
"src": "/avatar-example.svg",
|
|
"name": "Mark Wanner",
|
|
"alt": "Mark Wanner"
|
|
},
|
|
{
|
|
"src": "/avatar-example-2.svg",
|
|
"name": "Maria Guan",
|
|
"alt": "Maria Guan"
|
|
},
|
|
{
|
|
"src": "/avatar-example-3.svg",
|
|
"name": "Amil Evara",
|
|
"alt": "Amil Evara"
|
|
},
|
|
{
|
|
"initials": "EE",
|
|
"name": "Ebele Egbuna",
|
|
"color": "info"
|
|
}
|
|
]'
|
|
/></code></pre>
|
|
</section>
|
|
</div>
|
|
</article>
|
|
<article class="demo-case">
|
|
<header class="demo-case-header">
|
|
<div><span class="demo-case-eyebrow">Overflow</span><h2>Dropdown overflow</h2><p>Open the overflow counter to inspect members hidden by the visible limit.</p></div>
|
|
<span class="demo-case-number">05</span>
|
|
</header>
|
|
<div class="demo-workbench">
|
|
<div id="avatar-group-demo-5" class="demo-canvas demo-canvas--5">
|
|
<div class="demo-browser-chrome"><span></span><span></span><span></span><small>Live preview</small></div>
|
|
<div class="demo-render"><div data-component="AvatarGroup" items="[{"src":"/avatar-example.svg","name":"Mark Wanner","alt":"Mark Wanner"},{"src":"/avatar-example-2.svg","name":"Maria Guan","alt":"Maria Guan"},{"src":"/avatar-example-3.svg","name":"Amil Evara","alt":"Amil Evara"},{"initials":"EE","name":"Ebele Egbuna","color":"info"},{"initials":"CL","name":"Chris Lynch","color":"success"},{"initials":"NS","name":"Nora Singh","color":"warning"},{"initials":"JR","name":"Jon Rivera","color":"danger"},{"initials":"AK","name":"Amina Khan","color":"secondary"}]" size="md" color="primary" variant="solid" shape="circle" layout="stack" maxVisible="4" showTooltips="true"></div></div>
|
|
</div>
|
|
<section class="demo-code" aria-label="Dropdown overflow usage">
|
|
<header><span><span class="icon-[lucide--code-2] size-4" aria-hidden="true"></span>Component usage</span><small>.wrn</small></header>
|
|
<pre><code><AvatarGroup
|
|
items='[
|
|
{
|
|
"src": "/avatar-example.svg",
|
|
"name": "Mark Wanner",
|
|
"alt": "Mark Wanner"
|
|
},
|
|
{
|
|
"src": "/avatar-example-2.svg",
|
|
"name": "Maria Guan",
|
|
"alt": "Maria Guan"
|
|
},
|
|
{
|
|
"src": "/avatar-example-3.svg",
|
|
"name": "Amil Evara",
|
|
"alt": "Amil Evara"
|
|
},
|
|
{
|
|
"initials": "EE",
|
|
"name": "Ebele Egbuna",
|
|
"color": "info"
|
|
},
|
|
{
|
|
"initials": "CL",
|
|
"name": "Chris Lynch",
|
|
"color": "success"
|
|
},
|
|
{
|
|
"initials": "NS",
|
|
"name": "Nora Singh",
|
|
"color": "warning"
|
|
},
|
|
{
|
|
"initials": "JR",
|
|
"name": "Jon Rivera",
|
|
"color": "danger"
|
|
},
|
|
{
|
|
"initials": "AK",
|
|
"name": "Amina Khan",
|
|
"color": "secondary"
|
|
}
|
|
]'
|
|
/></code></pre>
|
|
</section>
|
|
</div>
|
|
</article></div></section>
|
|
<section id="events" class="detail-section"><div class="detail-section-heading"><span>Component events</span><h2>Events</h2><p>Public events declared by this component. Custom events bubble from the component root and expose state through <code>event.detail</code>.</p></div><div class="detail-events-grid"><div class="detail-events-list"><div><code>@overflow</code><span>Fires when the component emits the overflow event.</span></div></div><section class="demo-code"><header><span><span class="icon-[lucide--radio] size-4" aria-hidden="true"></span>Event listener</span><small>.js</small></header><pre><code>const component = document.querySelector('[data-wrn-events]')
|
|
|
|
component.addEventListener('overflow', (event) => {
|
|
console.log(event.detail)
|
|
})</code></pre></section></div></section>
|
|
<section id="api" class="detail-section"><div class="detail-section-heading"><span>Component API</span><h2>Props and configuration</h2><p>All content and behavior shown above is supplied through these props and slots.</p></div><div class="docs-table-wrap"><table class="docs-table"><thead><tr><th>Prop</th><th>Type</th><th>Default</th><th>Required</th></tr></thead><tbody><tr><td><code>items</code></td><td>string</td><td><code>[]</code></td><td>No</td></tr><tr><td><code>size</code></td><td>string</td><td><code>"md"</code></td><td>No</td></tr><tr><td><code>color</code></td><td>string</td><td><code>"primary"</code></td><td>No</td></tr><tr><td><code>variant</code></td><td>string</td><td><code>"solid"</code></td><td>No</td></tr><tr><td><code>shape</code></td><td>string</td><td><code>"circle"</code></td><td>No</td></tr><tr><td><code>layout</code></td><td>string</td><td><code>"stack"</code></td><td>No</td></tr><tr><td><code>maxVisible</code></td><td>number</td><td><code>4</code></td><td>No</td></tr><tr><td><code>columns</code></td><td>number</td><td><code>3</code></td><td>No</td></tr><tr><td><code>borderColor</code></td><td>string</td><td><code>""</code></td><td>No</td></tr><tr><td><code>showTooltips</code></td><td>boolean</td><td><code>true</code></td><td>No</td></tr><tr><td><code>overflowLabel</code></td><td>string</td><td><code>"Show remaining members"</code></td><td>No</td></tr><tr><td><code>class</code></td><td>string</td><td><code>""</code></td><td>No</td></tr></tbody></table></div></section>
|
|
</main>
|
|
<aside class="detail-aside">
|
|
<div class="detail-toc"><strong>On this page</strong><a href="#playground">Playground</a><a href="#avatar-group-demo-1">Overlapping stack</a><a href="#avatar-group-demo-2">Grid layout</a><a href="#avatar-group-demo-3">Custom border color</a><a href="#avatar-group-demo-4">Member tooltips</a><a href="#avatar-group-demo-5">Dropdown overflow</a><a href="#events">Events</a><a href="#api">Props API</a></div>
|
|
</aside>
|
|
</div>
|
|
<nav class="detail-pagination">
|
|
<a href="/components/avatar"><small>Previous</small><strong>← Avatar</strong></a>
|
|
<a href="/components/badge"><small>Next</small><strong>Badge →</strong></a>
|
|
</nav>
|
|
}
|
|
}
|