WRNexusJSDoc/app/pages/components/toggle-password.wrn

page TogglePasswordcomponent {
  seo {
    title = "TogglePassword component"
    description = "Accessible password field with optional show and hide controls."
  }

  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">TogglePassword</span></nav><section class="doc-intro"><span class="eyebrow">advanced-forms component</span><h1>TogglePassword</h1><p>Accessible password field with optional show and hide controls.</p><div class="doc-meta"><span>@wrnexus/ui 0.4.0</span><span>24 props</span><span>0 slots</span><span>3 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;TogglePassword
  size=&quot;default&quot;
  color=&quot;primary&quot;
  label=&quot;Password&quot;
  name=&quot;password&quot;
  value=&quot;value&quot;
/&gt;</code></pre><p>Legacy mount name: <code>data-component=&quot;TogglePassword&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;Password&quot;</code></td></tr><tr><td><code>name</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;password&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>placeholder</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;Enter your password&quot;</code></td></tr><tr><td><code>autocomplete</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;current-password&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;(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9])(?=.*[^A-Za-z0-9]).&#123;8,&#125;&quot;</code></td></tr><tr><td><code>fields</code></td><td><code>string</code></td><td>Optional</td><td><code>[]</code></td></tr><tr><td><code>visible</code></td><td><code>boolean</code></td><td>Optional</td><td><code>false</code></td></tr><tr><td><code>toggleable</code></td><td><code>boolean</code></td><td>Optional</td><td><code>true</code></td></tr><tr><td><code>toggleMode</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;button&quot;</code></td></tr><tr><td><code>checkboxLabel</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;Show password&quot;</code></td></tr><tr><td><code>showLabel</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;Show password&quot;</code></td></tr><tr><td><code>hideLabel</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;Hide password&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>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>invalid</code></td><td><code>boolean</code></td><td>Optional</td><td><code>false</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>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>toggle</code></li></ul></section><section id="source"><h2>Source contract</h2><p>Installed source: <code>components/TogglePassword.wrn</code></p><pre data-language="wrn"><code>component TogglePassword &#123;
  props &#123;
    size = &quot;default&quot;
    color = &quot;primary&quot;
    label = &quot;Password&quot;
    name = &quot;password&quot;
    value = &quot;&quot;
    placeholder = &quot;Enter your password&quot;
    autocomplete = &quot;current-password&quot;
    minlength = &quot;&quot;
    maxlength = &quot;&quot;
    pattern = &quot;(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9])(?=.*[^A-Za-z0-9]).&#123;8,&#125;&quot;
    fields = []
    visible = false
    toggleable = true
    toggleMode = &quot;button&quot;
    checkboxLabel = &quot;Show password&quot;
    showLabel = &quot;Show password&quot;
    hideLabel = &quot;Hide password&quot;
    disabled = false
    readonly = false
    required = false
    invalid = false
    helpText = &quot;&quot;
    validationMessage = &quot;&quot;
    class = &quot;&quot;
    @event input = function
    @event change = function
    @event toggle = function
  &#125;

  state revealed = visible

  functions &#123;
    function toggleVisibility() &#123;
      if (disabled || readonly || !toggleable) &#123;
        return
      &#125;
      revealed = !revealed
    &#125;

    function fieldId(field, index) &#123;
      return field.id || field.name || name + &quot;-&quot; + index
    &#125;

    function fieldName(field, index) &#123;
      return field.name || name + &quot;-&quot; + index
    &#125;
  &#125;

  view &#123;
        &lt;fieldset
      class=&quot;wire-next wire-next--color-&#123;color&#125; wire-next--size-&#123;size&#125; wire-next--toggle-password &#123;invalid ? 'wire-next--invalid' : ''&#125; &#123;disabled ? 'wire-next--disabled' : ''&#125; &#123;class&#125;&quot;
      data-wrn-toggle-password
      data-visible=&quot;&#123;revealed ? 'true' : 'false'&#125;&quot;
    &gt;
      &#123;#if fields.length&#125;
        &lt;div class=&quot;wire-next__password-fields&quot;&gt;
          &#123;#each fields as field, index&#125;
            &lt;div class=&quot;wire-next__password-field&quot;&gt;
        &lt;label for=&quot;&#123;fieldId(field, index)&#125;&quot;&gt;&#123;field.label || label&#125;&lt;/label&gt;
        &lt;div class=&quot;wire-next__password-control&quot;&gt;
        &lt;input
                  id=&quot;&#123;fieldId(field, index)&#125;&quot;
                  type=&quot;&#123;revealed ? 'text' : 'password'&#125;&quot;
                  name=&quot;&#123;fieldName(field, index)&#125;&quot;
                  value=&quot;&#123;field.value || ''&#125;&quot;
                  placeholder=&quot;&#123;field.placeholder || placeholder&#125;&quot;
                  autocomplete=&quot;&#123;field.autocomplete || autocomplete&#125;&quot;
                  minlength=&quot;&#123;field.minlength || minlength&#125;&quot;
                  maxlength=&quot;&#123;field.maxlength || maxlength&#125;&quot;
                  pattern=&quot;&#123;field.pattern || pattern&#125;&quot;
                  disabled=&quot;&#123;disabled || field.disabled&#125;&quot;
                  readonly=&quot;&#123;readonly || field.readonly&#125;&quot;
                  required=&quot;&#123;required || field.required&#125;&quot;
                  aria-invalid=&quot;&#123;invalid ? 'true' : 'false'&#125;&quot;
                  @input=&quot;$emit('input', &#123; name: event.target.name, value: event.target.value, visible: revealed &#125;)&quot;
                  @change=&quot;$emit('change', &#123; name: event.target.name, value: event.target.value, visible: revealed &#125;)&quot;
                /&gt;
                &#123;#if toggleable &amp;&amp; toggleMode === &quot;button&quot;&#125;
                  &lt;button
                    type=&quot;button&quot;
                    class=&quot;wire-next__password-toggle&quot;
                    aria-label=&quot;&#123;revealed ? hideLabel : showLabel&#125;&quot;
                    title=&quot;&#123;revealed ? hideLabel : showLabel&#125;&quot;
                    aria-pressed=&quot;&#123;revealed ? 'true' : 'false'&#125;&quot;
                    disabled=&quot;&#123;disabled || readonly&#125;&quot;
                    @click=&quot;toggleVisibility(); $emit('toggle', &#123; visible: revealed &#125;)&quot;
                  &gt;
        &lt;span class=&quot;wire-next__password-icon wire-next__password-icon--show&quot; aria-hidden=&quot;true&quot;&gt;
        &lt;/span&gt;
        &lt;/button&gt;
                &#123;/if&#125;
              &lt;/div&gt;
        &lt;/div&gt;
          &#123;/each&#125;
        &lt;/div&gt;
      &#123;:else&#125;
        &lt;label for=&quot;&#123;name&#125;-password&quot;&gt;&#123;label&#125;&lt;/label&gt;
        &lt;div class=&quot;wire-next__password-control&quot;&gt;
        &lt;input
            &#123;...attrs&#125;
            id=&quot;&#123;name&#125;-password&quot;
            type=&quot;&#123;revealed ? 'text' : 'password'&#125;&quot;
            name=&quot;&#123;name&#125;&quot;
            value=&quot;&#123;value&#125;&quot;
            placeholder=&quot;&#123;placeholder&#125;&quot;
            autocomplete=&quot;&#123;autocomplete&#125;&quot;
            minlength=&quot;&#123;minlength&#125;&quot;
            maxlength=&quot;&#123;maxlength&#125;&quot;
            pattern=&quot;&#123;pattern&#125;&quot;
            disabled=&quot;&#123;disabled&#125;&quot;
            readonly=&quot;&#123;readonly&#125;&quot;
            required=&quot;&#123;required&#125;&quot;
            aria-invalid=&quot;&#123;invalid ? 'true' : 'false'&#125;&quot;
            aria-describedby=&quot;&#123;validationMessage ? name + '-validation' : helpText ? name + '-help' : ''&#125;&quot;
            @input=&quot;$emit('input', &#123; value: event.target.value, visible: revealed &#125;)&quot;
            @change=&quot;$emit('change', &#123; value: event.target.value, visible: revealed &#125;)&quot;
          /&gt;
          &#123;#if toggleable &amp;&amp; toggleMode === &quot;button&quot;&#125;
            &lt;button
              type=&quot;button&quot;
              class=&quot;wire-next__password-toggle&quot;
              aria-label=&quot;&#123;revealed ? hideLabel : showLabel&#125;&quot;
              title=&quot;&#123;revealed ? hideLabel : showLabel&#125;&quot;
              aria-pressed=&quot;&#123;revealed ? 'true' : 'false'&#125;&quot;
              disabled=&quot;&#123;disabled || readonly&#125;&quot;
              @click=&quot;toggleVisibility(); $emit('toggle', &#123; visible: revealed &#125;)&quot;
            &gt;
        &lt;span class=&quot;wire-next__password-icon wire-next__password-icon--show&quot; aria-hidden=&quot;true&quot;&gt;
        &lt;/span&gt;
        &lt;/button&gt;
          &#123;/if&#125;
        &lt;/div&gt;
      &#123;/if&#125;
      &#123;#if toggleable &amp;&amp; toggleMode === &quot;checkbox&quot;&#125;
        &lt;label class=&quot;wire-next__password-checkbox&quot;&gt;
        &lt;input
            type=&quot;checkbox&quot;
            checked=&quot;&#123;revealed&#125;&quot;
            disabled=&quot;&#123;disabled || readonly&#125;&quot;
            @change=&quot;revealed = event.target.checked; $emit('toggle', &#123; visible: revealed &#125;)&quot;
          /&gt;
        &lt;span&gt;&#123;checkboxLabel&#125;&lt;/span&gt;
        &lt;/label&gt;
      &#123;/if&#125;
      &#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.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>
  }
}