136 lines
10 KiB
Plaintext
136 lines
10 KiB
Plaintext
page Badgecomponent {
|
|
seo {
|
|
title = "Badge component"
|
|
description = "Theme-aware, responsive badge 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">Badge</span></nav><section class="doc-intro"><span class="eyebrow">base component</span><h1>Badge</h1><p>Theme-aware, responsive badge component.</p><div class="doc-meta"><span>@wrnexus/ui 0.5.0</span><span>22 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><Badge
|
|
label="Badge"
|
|
size="md"
|
|
color="primary"
|
|
variant="solid"
|
|
shape="pill"
|
|
/></code></pre><p>Legacy mount name: <code>data-component="Badge"</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>label</code></td><td><code>string</code></td><td>Optional</td><td><code>"Badge"</code></td></tr><tr><td><code>size</code></td><td><code>string</code></td><td>Optional</td><td><code>"md"</code></td></tr><tr><td><code>color</code></td><td><code>string</code></td><td>Optional</td><td><code>"primary"</code></td></tr><tr><td><code>variant</code></td><td><code>string</code></td><td>Optional</td><td><code>"solid"</code></td></tr><tr><td><code>shape</code></td><td><code>string</code></td><td>Optional</td><td><code>"pill"</code></td></tr><tr><td><code>class</code></td><td><code>string</code></td><td>Optional</td><td><code>""</code></td></tr><tr><td><code>icon</code></td><td><code>string</code></td><td>Optional</td><td><code>""</code></td></tr><tr><td><code>iconPosition</code></td><td><code>string</code></td><td>Optional</td><td><code>"start"</code></td></tr><tr><td><code>dot</code></td><td><code>boolean</code></td><td>Optional</td><td><code>false</code></td></tr><tr><td><code>dotOnly</code></td><td><code>boolean</code></td><td>Optional</td><td><code>false</code></td></tr><tr><td><code>dotLabel</code></td><td><code>string</code></td><td>Optional</td><td><code>"Status"</code></td></tr><tr><td><code>animated</code></td><td><code>boolean</code></td><td>Optional</td><td><code>false</code></td></tr><tr><td><code>avatarSrc</code></td><td><code>string</code></td><td>Optional</td><td><code>""</code></td></tr><tr><td><code>avatarAlt</code></td><td><code>string</code></td><td>Optional</td><td><code>""</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>dismissLabel</code></td><td><code>string</code></td><td>Optional</td><td><code>"Remove badge"</code></td></tr><tr><td><code>truncate</code></td><td><code>boolean</code></td><td>Optional</td><td><code>false</code></td></tr><tr><td><code>maxWidth</code></td><td><code>string</code></td><td>Optional</td><td><code>"12rem"</code></td></tr><tr><td><code>anchorLabel</code></td><td><code>string</code></td><td>Optional</td><td><code>""</code></td></tr><tr><td><code>anchorIcon</code></td><td><code>string</code></td><td>Optional</td><td><code>""</code></td></tr><tr><td><code>placement</code></td><td><code>string</code></td><td>Optional</td><td><code>"inline"</code></td></tr><tr><td><code>anchorLabelText</code></td><td><code>string</code></td><td>Optional</td><td><code>"Badge anchor"</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>dismiss</code></li></ul></section><section id="source"><h2>Source contract</h2><p>Installed source: <code>components/Badge.wrn</code></p><pre data-language="wrn"><code>component Badge {
|
|
props {
|
|
label = "Badge"
|
|
size = "md"
|
|
color = "primary"
|
|
variant = "solid"
|
|
shape = "pill"
|
|
class = ""
|
|
|
|
icon = ""
|
|
iconPosition = "start"
|
|
dot = false
|
|
dotOnly = false
|
|
dotLabel = "Status"
|
|
animated = false
|
|
|
|
avatarSrc = ""
|
|
avatarAlt = ""
|
|
dismissible = false
|
|
dismissLabel = "Remove badge"
|
|
truncate = false
|
|
maxWidth = "12rem"
|
|
|
|
anchorLabel = ""
|
|
anchorIcon = ""
|
|
placement = "inline"
|
|
anchorLabelText = "Badge anchor"
|
|
|
|
@event dismiss = function
|
|
}
|
|
|
|
state visible = true
|
|
|
|
functions {
|
|
function dismissBadge(sourceEvent, root, customEvent) {
|
|
visible = false
|
|
root = sourceEvent.currentTarget.closest("[data-wrn-badge]")
|
|
customEvent = document.createEvent("CustomEvent")
|
|
customEvent.initCustomEvent("dismiss", true, false, {
|
|
component: "Badge",
|
|
label: label
|
|
})
|
|
root.dispatchEvent(customEvent)
|
|
}
|
|
}
|
|
|
|
view {
|
|
<span
|
|
{...attrs}
|
|
class="wire-next wire-next--badge-root {anchorLabel || anchorIcon ? 'wire-next--badge-anchored' : ''} {class}"
|
|
data-wrn-badge
|
|
data-placement="{placement}"
|
|
data-show="visible"
|
|
aria-hidden="{visible ? 'false' : 'true'}"
|
|
>
|
|
{#if anchorLabel || anchorIcon}
|
|
<button type="button" class="wire-next__badge-anchor" aria-label="{anchorLabelText}">
|
|
{#if anchorIcon}<span class="{anchorIcon}" aria-hidden="true">
|
|
</span>{/if}
|
|
{#if anchorLabel}<span>{anchorLabel}</span>{/if}
|
|
</button>
|
|
{/if}
|
|
|
|
<span
|
|
class="wire-next__badge"
|
|
data-size="{size}"
|
|
data-color="{color}"
|
|
data-variant="{variant}"
|
|
data-shape="{shape}"
|
|
data-animated="{animated ? 'true' : 'false'}"
|
|
style="--wire-badge-max-width:{maxWidth}"
|
|
role="{dotOnly ? 'status' : ''}"
|
|
aria-label="{dotOnly ? dotLabel : ''}"
|
|
>
|
|
{#if animated}
|
|
<span class="wire-next__badge-ping" aria-hidden="true">
|
|
</span>
|
|
{/if}
|
|
{#if avatarSrc}
|
|
<img class="wire-next__badge-avatar" src="{avatarSrc}" alt="{avatarAlt}" loading="lazy" />
|
|
{/if}
|
|
{#if dot || dotOnly}
|
|
<span class="wire-next__badge-dot" aria-hidden="true">
|
|
</span>
|
|
{/if}
|
|
{#if icon && iconPosition === "start"}
|
|
<span class="wire-next__badge-icon {icon}" aria-hidden="true">
|
|
</span>
|
|
{/if}
|
|
{#if !dotOnly}
|
|
<span class="wire-next__badge-label {truncate ? 'wire-next__badge-label--truncate' : ''}">
|
|
{label}
|
|
</span>
|
|
{/if}
|
|
{#if icon && iconPosition === "end"}
|
|
<span class="wire-next__badge-icon {icon}" aria-hidden="true">
|
|
</span>
|
|
{/if}
|
|
{#if dismissible}
|
|
<button type="button" class="wire-next__badge-dismiss" aria-label="{dismissLabel}" @click="dismissBadge(event)">
|
|
<span class="icon-[lucide--x]" aria-hidden="true">
|
|
</span>
|
|
</button>
|
|
{/if}
|
|
</span>
|
|
</span>
|
|
}
|
|
}
|
|
</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>
|
|
}
|
|
}
|