Files
WRNexusJSDoc/app/pages/components/input.wrn
T

121 lines
12 KiB
Plaintext

page Inputcomponent {
seo {
title = "Input component"
description = "Theme-aware, responsive input 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">Input</span></nav><section class="doc-intro"><span class="eyebrow">forms component</span><h1>Input</h1><p>Theme-aware, responsive input component.</p><div class="doc-meta"><span>@wrnexus/ui 0.5.0</span><span>28 props</span><span>0 slots</span><span>7 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;Input
size=&quot;default&quot;
color=&quot;primary&quot;
id=&quot;id&quot;
name=&quot;name&quot;
label=&quot;Input&quot;
/&gt;</code></pre><p>Legacy mount name: <code>data-component=&quot;Input&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>id</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>name</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>label</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;Input&quot;</code></td></tr><tr><td><code>hiddenLabel</code></td><td><code>boolean</code></td><td>Optional</td><td><code>false</code></td></tr><tr><td><code>placeholder</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>value</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;text&quot;</code></td></tr><tr><td><code>variant</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;normal&quot;</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>helperText</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>cornerHint</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>error</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>inline</code></td><td><code>boolean</code></td><td>Optional</td><td><code>false</code></td></tr><tr><td><code>readonly</code></td><td><code>boolean</code></td><td>Optional</td><td><code>false</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>required</code></td><td><code>boolean</code></td><td>Optional</td><td><code>false</code></td></tr><tr><td><code>autocomplete</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>inputmode</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>minlength</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>maxlength</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>pattern</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>min</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>max</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>step</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><p>This component does not declare a slot.</p></section><section id="events"><h2>Events</h2><ul><li><code>input</code></li><li><code>change</code></li><li><code>focus</code></li><li><code>blur</code></li><li><code>invalid</code></li><li><code>keydown</code></li><li><code>keyup</code></li></ul></section><section id="source"><h2>Source contract</h2><p>Installed source: <code>components/Input.wrn</code></p><pre data-language="wrn"><code>component Input &#123;
props &#123;
@event input = function
@event change = function
@event focus = function
@event blur = function
@event invalid = function
@event keydown = function
@event keyup = function
size = &quot;default&quot;
color = &quot;primary&quot;
id = &quot;&quot;
name = &quot;&quot;
label = &quot;Input&quot;
hiddenLabel = false
placeholder = &quot;&quot;
value = &quot;&quot;
type = &quot;text&quot;
variant = &quot;normal&quot;
icon = &quot;&quot;
iconPosition = &quot;start&quot;
helperText = &quot;&quot;
cornerHint = &quot;&quot;
error = &quot;&quot;
inline = false
readonly = false
disabled = false
required = false
autocomplete = &quot;&quot;
inputmode = &quot;&quot;
minlength = &quot;&quot;
maxlength = &quot;&quot;
pattern = &quot;&quot;
min = &quot;&quot;
max = &quot;&quot;
step = &quot;&quot;
class = &quot;&quot;
&#125;
functions &#123;
function detail(sourceEvent) &#123;
return &#123; value: sourceEvent.currentTarget.value, name: name, sourceEvent: sourceEvent &#125;
&#125;
function handleInput(sourceEvent) &#123; sourceEvent.stopPropagation(); $emit(&quot;input&quot;, detail(sourceEvent)) &#125;
function handleChange(sourceEvent) &#123; sourceEvent.stopPropagation(); $emit(&quot;change&quot;, detail(sourceEvent)) &#125;
function handleFocus(sourceEvent) &#123; sourceEvent.stopPropagation(); $emit(&quot;focus&quot;, detail(sourceEvent)) &#125;
function handleBlur(sourceEvent) &#123; sourceEvent.stopPropagation(); $emit(&quot;blur&quot;, detail(sourceEvent)) &#125;
function handleInvalid(sourceEvent) &#123; sourceEvent.stopPropagation(); $emit(&quot;invalid&quot;, &#123; value: sourceEvent.currentTarget.value, name: name, message: sourceEvent.currentTarget.validationMessage, sourceEvent: sourceEvent &#125;) &#125;
function handleKeydown(sourceEvent) &#123; sourceEvent.stopPropagation(); $emit(&quot;keydown&quot;, &#123; key: sourceEvent.key, value: sourceEvent.currentTarget.value, name: name, sourceEvent: sourceEvent &#125;) &#125;
function handleKeyup(sourceEvent) &#123; sourceEvent.stopPropagation(); $emit(&quot;keyup&quot;, &#123; key: sourceEvent.key, value: sourceEvent.currentTarget.value, name: name, sourceEvent: sourceEvent &#125;) &#125;
&#125;
view &#123;
&lt;div &#123;...attrs&#125; class=&quot;wire-next wire-next--color-&#123;color&#125; wire-next--size-&#123;size&#125; wire-next--field wire-next--input &#123;class&#125;&quot; data-variant=&quot;&#123;variant&#125;&quot; data-inline=&quot;&#123;inline&#125;&quot; data-floating=&quot;&#123;variant === 'floating'&#125;&quot; data-invalid=&quot;&#123;error ? 'true' : 'false'&#125;&quot;&gt;
&lt;div class=&quot;wire-next__field-heading&quot;&gt;
&lt;label class=&quot;&#123;hiddenLabel ? 'wire-next__sr-only' : ''&#125;&quot; for=&quot;&#123;id || name&#125;&quot;&gt;&#123;label&#125;&lt;/label&gt;
&#123;#if cornerHint&#125;&lt;span class=&quot;wire-next__field-hint&quot;&gt;&#123;cornerHint&#125;&lt;/span&gt;&#123;/if&#125;
&lt;/div&gt;
&lt;div class=&quot;wire-next__field-control&quot; data-icon-position=&quot;&#123;iconPosition&#125;&quot;&gt;
&#123;#if icon&#125;&lt;span class=&quot;&#123;icon&#125; wire-next__field-icon&quot; aria-hidden=&quot;true&quot;&gt;
&lt;/span&gt;&#123;/if&#125;
&lt;input
id=&quot;&#123;id || name&#125;&quot;
type=&quot;&#123;type&#125;&quot;
name=&quot;&#123;name&#125;&quot;
value=&quot;&#123;value&#125;&quot;
placeholder=&quot;&#123;variant === 'floating' ? ' ' : placeholder&#125;&quot;
readonly=&quot;&#123;readonly&#125;&quot;
disabled=&quot;&#123;disabled&#125;&quot;
required=&quot;&#123;required&#125;&quot;
autocomplete=&quot;&#123;autocomplete&#125;&quot;
inputmode=&quot;&#123;inputmode&#125;&quot;
minlength=&quot;&#123;minlength&#125;&quot;
maxlength=&quot;&#123;maxlength&#125;&quot;
pattern=&quot;&#123;pattern&#125;&quot;
min=&quot;&#123;min&#125;&quot;
max=&quot;&#123;max&#125;&quot;
step=&quot;&#123;step&#125;&quot;
aria-invalid=&quot;&#123;error ? 'true' : 'false'&#125;&quot;
aria-describedby=&quot;&#123;error ? (id || name) + '-error' : (helperText ? (id || name) + '-help' : '')&#125;&quot;
@input=&quot;handleInput(event)&quot;
@change=&quot;handleChange(event)&quot;
@focus=&quot;handleFocus(event)&quot;
@blur=&quot;handleBlur(event)&quot;
@invalid=&quot;handleInvalid(event)&quot;
@keydown=&quot;handleKeydown(event)&quot;
@keyup=&quot;handleKeyup(event)&quot;
/&gt;
&#123;#if variant === &quot;floating&quot;&#125;&lt;span class=&quot;wire-next__field-floating-label&quot;&gt;&#123;label&#125;&lt;/span&gt;&#123;/if&#125;
&lt;/div&gt;
&#123;#if helperText&#125;&lt;small id=&quot;&#123;(id || name) + '-help'&#125;&quot; class=&quot;wire-next__field-help&quot;&gt;&#123;helperText&#125;&lt;/small&gt;&#123;/if&#125;
&lt;small id=&quot;&#123;(id || name) + '-error'&#125;&quot; class=&quot;wire-next__field-error&quot; data-error=&quot;&#123;name&#125;&quot;&gt;&#123;error&#125;&lt;/small&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>
}
}