WorkRoot/WRNexusJSDoc
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update portal for WRnexusJS 0.5.0

Browse Source
This commit is contained in:
Clintchiz
2026-07-29 13:18:08 +05:30
parent a09b791840
commit 19e20408db
164 changed files with 5578 additions and 1378 deletions
Download Patch File Download Diff File Expand all files Collapse all files
app/pages/components/alert.wrn
+146 -17
View File
@@ -10,36 +10,165 @@ page Alertcomponent {
<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>
<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">Alert</span></nav><section class="doc-intro"><span class="eyebrow">base component</span><h1>Alert</h1><p>Theme-aware, responsive alert component.</p><div class="doc-meta"><span>@wrnexus/ui 0.4.0</span><span>7 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;Alert
<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">Alert</span></nav><section class="doc-intro"><span class="eyebrow">base component</span><h1>Alert</h1><p>Theme-aware, responsive alert component.</p><div class="doc-meta"><span>@wrnexus/ui 0.5.0</span><span>21 props</span><span>0 slots</span><span>2 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;Alert
size=&quot;default&quot;
color=&quot;primary&quot;
title=&quot;Alert&quot;
description=&quot;description&quot;
items=&quot;[]&quot;
/&gt;</code></pre><p>Legacy mount name: <code>data-component=&quot;Alert&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>size</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>title</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;Alert&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>items</code></td><td><code>string</code></td><td>Optional</td><td><code>[]</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>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/alert.wrn</code></p><pre data-language="wrn"><code>component Alert &#123;
color=&quot;info&quot;
variant=&quot;soft&quot;
radius=&quot;md&quot;
shadow=&quot;sm&quot;
/&gt;</code></pre><p>Legacy mount name: <code>data-component=&quot;Alert&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>size</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;info&quot;</code></td></tr><tr><td><code>variant</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;soft&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><tr><td><code>radius</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;md&quot;</code></td></tr><tr><td><code>shadow</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;sm&quot;</code></td></tr><tr><td><code>title</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;Alert&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>items</code></td><td><code>string</code></td><td>Optional</td><td><code>[]</code></td></tr><tr><td><code>actions</code></td><td><code>string</code></td><td>Optional</td><td><code>[]</code></td></tr><tr><td><code>showIcon</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>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>&quot;Dismiss alert&quot;</code></td></tr><tr><td><code>role</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;alert&quot;</code></td></tr><tr><td><code>live</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;polite&quot;</code></td></tr><tr><td><code>linkLabel</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>linkHref</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>actionLabel</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>actionHref</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>compact</code></td><td><code>boolean</code></td><td>Optional</td><td><code>false</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><li><code>action</code></li></ul></section><section id="source"><h2>Source contract</h2><p>Installed source: <code>components/alert.wrn</code></p><pre data-language="wrn"><code>component Alert &#123;
props &#123;
size = &quot;default&quot;
color = &quot;primary&quot;
color = &quot;info&quot;
variant = &quot;soft&quot;
class = &quot;&quot;
radius = &quot;md&quot;
shadow = &quot;sm&quot;
title = &quot;Alert&quot;
description = &quot;&quot;
items = []
variant = &quot;default&quot;
class = &quot;&quot;
actions = []
showIcon = false
icon = &quot;&quot;
dismissible = false
dismissLabel = &quot;Dismiss alert&quot;
role = &quot;alert&quot;
live = &quot;polite&quot;
linkLabel = &quot;&quot;
linkHref = &quot;&quot;
actionLabel = &quot;&quot;
actionHref = &quot;&quot;
compact = false
@event dismiss = function
@event action = function
&#125;
state visible = true
functions &#123;
function dispatchAlertEvent(sourceEvent, eventName, action, root, customEvent) &#123;
root = sourceEvent.currentTarget.closest(&quot;[data-wrn-alert]&quot;)
if (!root) &#123;
return
&#125;
customEvent = document.createEvent(&quot;CustomEvent&quot;)
customEvent.initCustomEvent(eventName, true, false, &#123;
component: &quot;Alert&quot;,
title: title,
color: color,
variant: variant,
action: action
&#125;)
root.dispatchEvent(customEvent)
&#125;
function dismissAlert(sourceEvent) &#123;
visible = false
dispatchAlertEvent(sourceEvent, &quot;dismiss&quot;, null)
&#125;
function selectAction(sourceEvent, action) &#123;
dispatchAlertEvent(sourceEvent, &quot;action&quot;, action)
&#125;
&#125;
view &#123;
&lt;section class=&quot;wire-next wire-next--color-&#123;color&#125; wire-next--size-&#123;size&#125; wire-next--alert wire-next--variant-&#123;variant&#125; &#123;class&#125;&quot;&gt;
&#123;#if title&#125;&lt;strong&gt;&#123;title&#125;&lt;/strong&gt;&#123;/if&#125;
&#123;#if description&#125;&lt;p&gt;&#123;description&#125;&lt;/p&gt;&#123;/if&#125;
&#123;#if items&#125;&lt;div class=&quot;wire-next__items&quot;&gt;&#123;#each items as item&#125;&lt;span&gt;&#123;item.label&#125;&lt;/span&gt;&#123;/each&#125;&lt;/div&gt;&#123;/if&#125;
&lt;slot /&gt;
&lt;/section&gt;
&lt;section
&#123;...attrs&#125;
data-wrn-alert
data-color=&quot;&#123;color&#125;&quot;
data-variant=&quot;&#123;variant&#125;&quot;
data-radius=&quot;&#123;radius&#125;&quot;
data-shadow=&quot;&#123;shadow&#125;&quot;
data-show=&quot;visible&quot;
aria-hidden=&quot;&#123;visible ? 'false' : 'true'&#125;&quot;
role=&quot;&#123;role&#125;&quot;
aria-live=&quot;&#123;live&#125;&quot;
class=&quot;wire-next wire-next--color-&#123;color&#125; wire-next--size-&#123;size&#125; wire-next--alert wire-next--alert-&#123;variant&#125; &#123;compact ? 'wire-next--alert-compact' : ''&#125; &#123;class&#125;&quot;
&gt;
&#123;#if showIcon&#125;
&lt;span class=&quot;wire-next__alert-icon&quot; aria-hidden=&quot;true&quot;&gt;
&#123;#if icon&#125;
&lt;span class=&quot;&#123;icon&#125;&quot;&gt;
&lt;/span&gt;
&#123;:else if color === &quot;success&quot;&#125;
&lt;span class=&quot;icon-[lucide--circle-check]&quot;&gt;
&lt;/span&gt;
&#123;:else if color === &quot;danger&quot;&#125;
&lt;span class=&quot;icon-[lucide--circle-x]&quot;&gt;
&lt;/span&gt;
&#123;:else if color === &quot;warning&quot;&#125;
&lt;span class=&quot;icon-[lucide--triangle-alert]&quot;&gt;
&lt;/span&gt;
&#123;:else&#125;
&lt;span class=&quot;icon-[lucide--info]&quot;&gt;
&lt;/span&gt;
&#123;/if&#125;
&lt;/span&gt;
&#123;/if&#125;
&lt;div class=&quot;wire-next__alert-body&quot;&gt;
&#123;#if title&#125;&lt;strong class=&quot;wire-next__alert-title&quot;&gt;&#123;title&#125;&lt;/strong&gt;&#123;/if&#125;
&#123;#if description&#125;&lt;p&gt;&#123;description&#125;&lt;/p&gt;&#123;/if&#125;
&#123;#if items.length &gt; 0&#125;
&lt;ul&gt;
&#123;#each items as item&#125;&lt;li&gt;&#123;item.label || item&#125;&lt;/li&gt;&#123;/each&#125;
&lt;/ul&gt;
&#123;/if&#125;
&#123;#if actions.length &gt; 0 || actionLabel || linkLabel&#125;
&lt;div class=&quot;wire-next__alert-actions&quot;&gt;
&#123;#each actions as item&#125;
&lt;a
href=&quot;&#123;item.href || '#'&#125;&quot;
data-variant=&quot;&#123;item.variant || 'link'&#125;&quot;
@click=&quot;selectAction(event, item)&quot;
&gt;&#123;item.label&#125;&lt;/a&gt;
&#123;/each&#125;
&#123;#if actionLabel&#125;
&lt;a
href=&quot;&#123;actionHref || '#'&#125;&quot;
data-variant=&quot;action&quot;
@click=&quot;selectAction(event, &#123; label: actionLabel, href: actionHref &#125;)&quot;
&gt;&#123;actionLabel&#125;&lt;/a&gt;
&#123;/if&#125;
&#123;#if linkLabel&#125;
&lt;a
href=&quot;&#123;linkHref || '#'&#125;&quot;
data-variant=&quot;link&quot;
@click=&quot;selectAction(event, &#123; label: linkLabel, href: linkHref &#125;)&quot;
&gt;&#123;linkLabel&#125;&lt;/a&gt;
&#123;/if&#125;
&lt;/div&gt;
&#123;/if&#125;
&lt;/div&gt;
&#123;#if dismissible&#125;
&lt;button
type=&quot;button&quot;
class=&quot;wire-next__alert-dismiss&quot;
aria-label=&quot;&#123;dismissLabel&#125;&quot;
@click=&quot;dismissAlert(event)&quot;
&gt;
&lt;span class=&quot;icon-[lucide--x]&quot; aria-hidden=&quot;true&quot;&gt;
&lt;/span&gt;
&lt;/button&gt;
&#123;/if&#125;
&lt;/section&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>
<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>
}