WRNexusJSDoc/app/pages/components/pin-input.wrn

page PinInputcomponent {
  seo {
    title = "PinInput component"
    description = "Secure multi-cell PIN and verification-code input with regex and paste support."
  }

  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.3.5</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">PinInput</span></nav><section class="doc-intro"><span class="eyebrow">advanced-forms component</span><h1>PinInput</h1><p>Secure multi-cell PIN and verification-code input with regex and paste support.</p><div class="doc-meta"><span>@wrnexus/ui 0.3.5</span><span>26 props</span><span>0 slots</span><span>6 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;PinInput
  size=&quot;default&quot;
  color=&quot;primary&quot;
  label=&quot;Verification code&quot;
  name=&quot;pin&quot;
  value=&quot;value&quot;
/&gt;</code></pre><p>Legacy mount name: <code>data-component=&quot;PinInput&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>label</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;Verification code&quot;</code></td></tr><tr><td><code>name</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;pin&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>length</code></td><td><code>number</code></td><td>Optional</td><td><code>4</code></td></tr><tr><td><code>pattern</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;[0-9]&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>inputMode</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;numeric&quot;</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>autocomplete</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;one-time-code&quot;</code></td></tr><tr><td><code>masked</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>readonly</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>autoFocus</code></td><td><code>boolean</code></td><td>Optional</td><td><code>false</code></td></tr><tr><td><code>autoSubmit</code></td><td><code>boolean</code></td><td>Optional</td><td><code>false</code></td></tr><tr><td><code>allowPaste</code></td><td><code>boolean</code></td><td>Optional</td><td><code>true</code></td></tr><tr><td><code>clearable</code></td><td><code>boolean</code></td><td>Optional</td><td><code>true</code></td></tr><tr><td><code>clearLabel</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;Clear code&quot;</code></td></tr><tr><td><code>separator</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>groupSize</code></td><td><code>number</code></td><td>Optional</td><td><code>0</code></td></tr><tr><td><code>helpText</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;&quot;</code></td></tr><tr><td><code>invalid</code></td><td><code>boolean</code></td><td>Optional</td><td><code>false</code></td></tr><tr><td><code>validationMessage</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>complete</code></li><li><code>paste</code></li><li><code>clear</code></li><li><code>error</code></li></ul></section><section id="source"><h2>Source contract</h2><p>Installed source: <code>components/PinInput.wrn</code></p><pre data-language="wrn"><code>component PinInput &#123;
  props &#123;
    size = &quot;default&quot;
    color = &quot;primary&quot;
    label = &quot;Verification code&quot;
    name = &quot;pin&quot;
    value = &quot;&quot;
    length = 4
    pattern = &quot;[0-9]&quot;
    type = &quot;text&quot;
    inputMode = &quot;numeric&quot;
    placeholder = &quot;○&quot;
    autocomplete = &quot;one-time-code&quot;
    masked = false
    disabled = false
    readonly = false
    required = false
    autoFocus = false
    autoSubmit = false
    allowPaste = true
    clearable = true
    clearLabel = &quot;Clear code&quot;
    separator = &quot;&quot;
    groupSize = 0
    helpText = &quot;&quot;
    invalid = false
    validationMessage = &quot;&quot;
    class = &quot;&quot;
    @event input = function
    @event change = function
    @event complete = function
    @event paste = function
    @event clear = function
    @event error = function
  &#125;

  functions &#123;
    function inputIndexes() &#123;
      return [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11].slice(
        0,
        Math.max(1, Math.min(12, Number(length)))
      )
    &#125;
  &#125;

  view &#123;
        &lt;fieldset
      &#123;...attrs&#125;
      class=&quot;wire-next wire-next--color-&#123;color&#125; wire-next--size-&#123;size&#125; wire-next--pin-input &#123;invalid ? 'wire-next--invalid' : ''&#125; &#123;disabled ? 'wire-next--disabled' : ''&#125; &#123;class&#125;&quot;
      data-wrn-pin-input
      data-length=&quot;&#123;length&#125;&quot;
      data-pattern=&quot;&#123;pattern&#125;&quot;
      data-allow-paste=&quot;&#123;allowPaste ? 'true' : 'false'&#125;&quot;
      data-auto-submit=&quot;&#123;autoSubmit ? 'true' : 'false'&#125;&quot;
      data-value=&quot;&#123;value&#125;&quot;
      disabled=&quot;&#123;disabled&#125;&quot;
      aria-describedby=&quot;&#123;validationMessage ? `$&#123;name&#125;-validation` : helpText ? `$&#123;name&#125;-help` : ''&#125;&quot;
    &gt;
        &lt;div class=&quot;wire-next__pin-heading&quot;&gt;
        &lt;legend&gt;&#123;label&#125;&lt;/legend&gt;
        &lt;button
          type=&quot;button&quot;
          class=&quot;wire-next__pin-clear&quot;
          data-pin-clear
          aria-label=&quot;&#123;clearLabel&#125;&quot;
          title=&quot;&#123;clearLabel&#125;&quot;
          style=&quot;&#123;clearable &amp;&amp; value ? '' : 'display: none'&#125;&quot;
        &gt;
        &lt;span class=&quot;icon-[lucide--rotate-ccw]&quot; aria-hidden=&quot;true&quot;&gt;
        &lt;/span&gt;
        &lt;span&gt;&#123;clearLabel&#125;&lt;/span&gt;
        &lt;/button&gt;
        &lt;/div&gt;
        &lt;div class=&quot;wire-next__pin-cells&quot; role=&quot;group&quot; aria-label=&quot;&#123;label&#125;&quot;&gt;
        &#123;#each inputIndexes() as index&#125;
          &lt;input
            data-pin-cell
            data-pin-index=&quot;&#123;index&#125;&quot;
            id=&quot;&#123;name&#125;-&#123;index&#125;&quot;
            type=&quot;&#123;masked ? 'password' : type&#125;&quot;
            inputmode=&quot;&#123;inputMode&#125;&quot;
            maxlength=&quot;1&quot;
            value=&quot;&#123;value[index] || ''&#125;&quot;
            placeholder=&quot;&#123;placeholder&#125;&quot;
            autocomplete=&quot;&#123;index === 0 ? autocomplete : 'off'&#125;&quot;
            aria-label=&quot;&#123;label&#125; digit &#123;index + 1&#125; of &#123;length&#125;&quot;
            aria-required=&quot;&#123;required ? 'true' : 'false'&#125;&quot;
            readonly=&quot;&#123;readonly&#125;&quot;
            disabled=&quot;&#123;disabled&#125;&quot;
            autofocus=&quot;&#123;autoFocus &amp;&amp; index === 0&#125;&quot;
          /&gt;
          &#123;#if separator &amp;&amp; groupSize !== 0 &amp;&amp; (index + 1) % groupSize === 0 &amp;&amp; index + 1 !== length&#125;
            &lt;span class=&quot;wire-next__pin-separator&quot; aria-hidden=&quot;true&quot;&gt;&#123;separator&#125;&lt;/span&gt;
          &#123;/if&#125;
        &#123;/each&#125;
      &lt;/div&gt;
        &lt;input
        type=&quot;hidden&quot;
        name=&quot;&#123;name&#125;&quot;
        value=&quot;&#123;value&#125;&quot;
        required=&quot;&#123;required&#125;&quot;
        data-pin-value
      /&gt;

      &#123;#if helpText &amp;&amp; !validationMessage&#125;&lt;small id=&quot;&#123;name&#125;-help&quot;&gt;&#123;helpText&#125;&lt;/small&gt;&#123;/if&#125;
      &lt;small
        id=&quot;&#123;name&#125;-validation&quot;
        class=&quot;wire-next__validation&quot;
        data-error=&quot;&#123;name&#125;&quot;
      &gt;&#123;validationMessage&#125;&lt;/small&gt;
        &lt;/fieldset&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.3.5</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>
  }
}