WorkRoot/WRNexusJSDoc
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
4846b3684bd8b81353260beaf7b55f72d0b76c8f
WRNexusJSDoc/app/pages/components/button.wrn
T

189 lines
13 KiB
Plaintext
Raw Blame History

page Buttoncomponent {
seo {
title = "Button component"
description = "Theme-aware, responsive button 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.4.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">Button</span></nav><section class="doc-intro"><span class="eyebrow">base component</span><h1>Button</h1><p>Theme-aware, responsive button component.</p><div class="doc-meta"><span>@wrnexus/ui 0.4.0</span><span>25 props</span><span>1 slots</span><span>0 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;Button
label=&quot;Button&quot;
loadingLabel=&quot;Loading…&quot;
description=&quot;description&quot;
as=&quot;as&quot;
href=&quot;href&quot;
/&gt;</code></pre><p>Legacy mount name: <code>data-component=&quot;Button&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>label</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;Button&quot;</code></td></tr><tr><td><code>loadingLabel</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;Loading…&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>as</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>href</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>target</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>rel</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>type</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;button&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>color</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;primary&quot;</code></td></tr><tr><td><code>size</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;default&quot;</code></td></tr><tr><td><code>disabled</code></td><td><code>boolean</code></td><td>Optional</td><td><code>false</code></td></tr><tr><td><code>loading</code></td><td><code>boolean</code></td><td>Optional</td><td><code>false</code></td></tr><tr><td><code>pill</code></td><td><code>boolean</code></td><td>Optional</td><td><code>false</code></td></tr><tr><td><code>fullWidth</code></td><td><code>boolean</code></td><td>Optional</td><td><code>false</code></td></tr><tr><td><code>icon</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>iconPosition</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;start&quot;</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>ariaPressed</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>ariaExpanded</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>ariaControls</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>title</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>autofocus</code></td><td><code>boolean</code></td><td>Optional</td><td><code>false</code></td></tr><tr><td><code>controlClass</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><p>This component does not declare a custom event.</p></section><section id="source"><h2>Source contract</h2><p>Installed source: <code>components/button.wrn</code></p><pre data-language="wrn"><code>component Button &#123;
props &#123;
label = &quot;Button&quot;
loadingLabel = &quot;Loading…&quot;
description = &quot;&quot;
as = &quot;&quot;
href = &quot;&quot;
target = &quot;&quot;
rel = &quot;&quot;
type = &quot;button&quot;
variant = &quot;default&quot;
color = &quot;primary&quot;
size = &quot;default&quot;
disabled = false
loading = false
pill = false
fullWidth = false
icon = &quot;&quot;
iconPosition = &quot;start&quot;
ariaLabel = &quot;&quot;
ariaPressed = &quot;&quot;
ariaExpanded = &quot;&quot;
ariaControls = &quot;&quot;
title = &quot;&quot;
autofocus = false
controlClass = &quot;&quot;
class = &quot;&quot;
&#125;
view &#123;
&lt;span
class=&quot;wire-action &#123;fullWidth ? 'w-full' : ''&#125; &#123;class&#125;&quot;
&gt;
&#123;#if as === &quot;a&quot; || (as === &quot;&quot; &amp;&amp; href)&#125;
&lt;a
&#123;...attrs&#125;
href=&quot;&#123;disabled || loading ? '' : href&#125;&quot;
target=&quot;&#123;target&#125;&quot;
rel=&quot;&#123;rel&#125;&quot;
title=&quot;&#123;title&#125;&quot;
aria-label=&quot;&#123;ariaLabel || ((size === 'icon' || size === 'icon-xs' || size === 'icon-sm' || size === 'icon-lg') ? label : '')&#125;&quot;
aria-disabled=&quot;&#123;disabled || loading&#125;&quot;
aria-busy=&quot;&#123;loading&#125;&quot;
aria-pressed=&quot;&#123;ariaPressed&#125;&quot;
aria-expanded=&quot;&#123;ariaExpanded&#125;&quot;
aria-controls=&quot;&#123;ariaControls&#125;&quot;
tabindex=&quot;&#123;disabled || loading ? '-1' : '0'&#125;&quot;
class=&quot;wire-btn wire-btn--variant-&#123;variant&#125; wire-btn--color-&#123;color&#125; wire-btn--size-&#123;size&#125; &#123;pill ? 'wire-btn--pill' : ''&#125; &#123;description ? 'wire-btn--with-description' : ''&#125; &#123;fullWidth ? 'w-full' : ''&#125; &#123;controlClass&#125;&quot;
&gt;
&#123;#if loading&#125;
&lt;span
class=&quot;wire-spinner wire-spinner--inline&quot;
aria-hidden=&quot;true&quot;
&gt;
&lt;/span&gt;
&#123;/if&#125;
&#123;#if icon &amp;&amp; !loading &amp;&amp; iconPosition === &quot;start&quot;&#125;
&lt;span
class=&quot;wire-btn__icon &#123;icon&#125;&quot;
aria-hidden=&quot;true&quot;
&gt;
&lt;/span&gt;
&#123;/if&#125;
&lt;span
class=&quot;wire-btn__copy &#123;(size === 'icon' || size === 'icon-xs' || size === 'icon-sm' || size === 'icon-lg') ? 'wire-visually-hidden' : ''&#125;&quot;
&gt;
&lt;span
class=&quot;wire-btn__label&quot;
&gt;
&lt;slot&gt;&#123;loading ? loadingLabel : label&#125;&lt;/slot&gt;
&lt;/span&gt;
&#123;#if description &amp;&amp; !loading&#125;
&lt;span
class=&quot;wire-btn__description&quot;
&gt;
&#123;description&#125;
&lt;/span&gt;
&#123;/if&#125;
&lt;/span&gt;
&#123;#if icon &amp;&amp; !loading &amp;&amp; iconPosition === &quot;end&quot;&#125;
&lt;span
class=&quot;wire-btn__icon &#123;icon&#125;&quot;
aria-hidden=&quot;true&quot;
&gt;
&lt;/span&gt;
&#123;/if&#125;
&#123;#if (size === &quot;icon&quot; || size === &quot;icon-xs&quot; || size === &quot;icon-sm&quot; || size === &quot;icon-lg&quot;) &amp;&amp; (ariaLabel || label)&#125;
&lt;span
class=&quot;wire-btn__tooltip&quot;
role=&quot;tooltip&quot;
aria-hidden=&quot;true&quot;
&gt;
&#123;ariaLabel || label&#125;
&lt;/span&gt;
&#123;/if&#125;
&lt;/a&gt;
&#123;:else&#125;
&lt;button
&#123;...attrs&#125;
type=&quot;&#123;type&#125;&quot;
title=&quot;&#123;title&#125;&quot;
autofocus=&quot;&#123;autofocus&#125;&quot;
disabled=&quot;&#123;disabled || loading&#125;&quot;
aria-label=&quot;&#123;ariaLabel || ((size === 'icon' || size === 'icon-xs' || size === 'icon-sm' || size === 'icon-lg') ? label : '')&#125;&quot;
aria-busy=&quot;&#123;loading&#125;&quot;
aria-pressed=&quot;&#123;ariaPressed&#125;&quot;
aria-expanded=&quot;&#123;ariaExpanded&#125;&quot;
aria-controls=&quot;&#123;ariaControls&#125;&quot;
class=&quot;wire-btn wire-btn--variant-&#123;variant&#125; wire-btn--color-&#123;color&#125; wire-btn--size-&#123;size&#125; &#123;pill ? 'wire-btn--pill' : ''&#125; &#123;description ? 'wire-btn--with-description' : ''&#125; &#123;fullWidth ? 'w-full' : ''&#125; &#123;controlClass&#125;&quot;
&gt;
&#123;#if loading&#125;
&lt;span
class=&quot;wire-spinner wire-spinner--inline&quot;
aria-hidden=&quot;true&quot;
&gt;
&lt;/span&gt;
&#123;/if&#125;
&#123;#if icon &amp;&amp; !loading &amp;&amp; iconPosition === &quot;start&quot;&#125;
&lt;span
class=&quot;wire-btn__icon &#123;icon&#125;&quot;
aria-hidden=&quot;true&quot;
&gt;
&lt;/span&gt;
&#123;/if&#125;
&lt;span
class=&quot;wire-btn__copy &#123;(size === 'icon' || size === 'icon-xs' || size === 'icon-sm' || size === 'icon-lg') ? 'wire-visually-hidden' : ''&#125;&quot;
&gt;
&lt;span
class=&quot;wire-btn__label&quot;
&gt;
&lt;slot&gt;&#123;loading ? loadingLabel : label&#125;&lt;/slot&gt;
&lt;/span&gt;
&#123;#if description &amp;&amp; !loading&#125;
&lt;span
class=&quot;wire-btn__description&quot;
&gt;
&#123;description&#125;
&lt;/span&gt;
&#123;/if&#125;
&lt;/span&gt;
&#123;#if icon &amp;&amp; !loading &amp;&amp; iconPosition === &quot;end&quot;&#125;
&lt;span
class=&quot;wire-btn__icon &#123;icon&#125;&quot;
aria-hidden=&quot;true&quot;
&gt;
&lt;/span&gt;
&#123;/if&#125;
&#123;#if (size === &quot;icon&quot; || size === &quot;icon-xs&quot; || size === &quot;icon-sm&quot; || size === &quot;icon-lg&quot;) &amp;&amp; (ariaLabel || label)&#125;
&lt;span
class=&quot;wire-btn__tooltip&quot;
role=&quot;tooltip&quot;
aria-hidden=&quot;true&quot;
&gt;
&#123;ariaLabel || label&#125;
&lt;/span&gt;
&#123;/if&#125;
&lt;/button&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.4.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>
}
}
Reference in New Issue View Git Blame Copy Permalink