WRNexusJSDoc/app/pages/components/checkbox.wrn

page Checkboxcomponent {
  seo {
    title = "Checkbox component"
    description = "Theme-aware, responsive checkbox 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">Checkbox</span></nav><section class="doc-intro"><span class="eyebrow">forms component</span><h1>Checkbox</h1><p>Theme-aware, responsive checkbox component.</p><div class="doc-meta"><span>@wrnexus/ui 0.5.0</span><span>27 props</span><span>0 slots</span><span>5 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;Checkbox
  size=&quot;default&quot;
  color=&quot;primary&quot;
  id=&quot;id&quot;
  name=&quot;name&quot;
  label=&quot;Checkbox&quot;
/&gt;</code></pre><p>Legacy mount name: <code>data-component=&quot;Checkbox&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;Checkbox&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>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>value</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;on&quot;</code></td></tr><tr><td><code>values</code></td><td><code>string</code></td><td>Optional</td><td><code>[]</code></td></tr><tr><td><code>options</code></td><td><code>string</code></td><td>Optional</td><td><code>[]</code></td></tr><tr><td><code>checked</code></td><td><code>boolean</code></td><td>Optional</td><td><code>false</code></td></tr><tr><td><code>indeterminate</code></td><td><code>boolean</code></td><td>Optional</td><td><code>false</code></td></tr><tr><td><code>orientation</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;vertical&quot;</code></td></tr><tr><td><code>card</code></td><td><code>boolean</code></td><td>Optional</td><td><code>false</code></td></tr><tr><td><code>rightAligned</code></td><td><code>boolean</code></td><td>Optional</td><td><code>false</code></td></tr><tr><td><code>list</code></td><td><code>boolean</code></td><td>Optional</td><td><code>false</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>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></ul></section><section id="source"><h2>Source contract</h2><p>Installed source: <code>components/Checkbox.wrn</code></p><pre data-language="wrn"><code>component Checkbox &#123;
  props &#123;
    @event input = function
    @event change = function
    @event focus = function
    @event blur = function
    @event invalid = function
    size = &quot;default&quot;
    color = &quot;primary&quot;
    id = &quot;&quot;
    name = &quot;&quot;
    label = &quot;Checkbox&quot;
    hiddenLabel = false
    placeholder = &quot;&quot;
    variant = &quot;normal&quot;
    icon = &quot;&quot;
    iconPosition = &quot;start&quot;
    value = &quot;on&quot;
    values = []
    options = []
    checked = false
    indeterminate = false
    orientation = &quot;vertical&quot;
    card = false
    rightAligned = false
    list = false
    helperText = &quot;&quot;
    cornerHint = &quot;&quot;
    error = &quot;&quot;
    inline = false
    readonly = false
    disabled = false
    required = false
    class = &quot;&quot;
  &#125;
  functions &#123;
    function emitField(nameEvent, sourceEvent) &#123; sourceEvent.stopPropagation(); $emit(nameEvent, &#123; checked: sourceEvent.currentTarget.checked, value: sourceEvent.currentTarget.value, values: values, name: name, sourceEvent: sourceEvent &#125;) &#125;
    function preventReadonly(sourceEvent) &#123; if (readonly) sourceEvent.preventDefault() &#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--choice-field wire-next--checkbox-field &#123;class&#125;&quot; data-inline=&quot;&#123;inline&#125;&quot; data-invalid=&quot;&#123;error ? 'true' : 'false'&#125;&quot; data-orientation=&quot;&#123;orientation&#125;&quot; data-card=&quot;&#123;card&#125;&quot; data-list=&quot;&#123;list&#125;&quot; data-right-aligned=&quot;&#123;rightAligned&#125;&quot;&gt;
        &lt;div class=&quot;wire-next__field-heading&quot;&gt;&#123;#if options.length || cornerHint&#125;&lt;span class=&quot;&#123;hiddenLabel ? 'wire-next__sr-only' : ''&#125;&quot;&gt;&#123;label&#125;&lt;/span&gt;&#123;#if cornerHint&#125;&lt;span class=&quot;wire-next__field-hint&quot;&gt;&#123;cornerHint&#125;&lt;/span&gt;&#123;/if&#125;&#123;/if&#125;&lt;/div&gt;
      &#123;#if options.length&#125;
        &lt;div class=&quot;wire-next__checkbox-group&quot; role=&quot;group&quot; aria-label=&quot;&#123;hiddenLabel ? label : ''&#125;&quot; aria-invalid=&quot;&#123;error ? 'true' : 'false'&#125;&quot;&gt;
          &#123;#each options as option&#125;
            &lt;label class=&quot;wire-next__choice wire-next--checkbox&quot; for=&quot;&#123;id || name&#125;-&#123;option.value&#125;&quot; data-variant=&quot;&#123;variant&#125;&quot; data-disabled=&quot;&#123;disabled || option.disabled&#125;&quot;&gt;
        &lt;input id=&quot;&#123;id || name&#125;-&#123;option.value&#125;&quot; type=&quot;checkbox&quot; name=&quot;&#123;name&#125;&quot; value=&quot;&#123;option.value&#125;&quot; checked=&quot;&#123;values.includes(option.value) || option.checked&#125;&quot; disabled=&quot;&#123;disabled || option.disabled&#125;&quot; required=&quot;&#123;required&#125;&quot; readonly=&quot;&#123;readonly&#125;&quot; @click=&quot;preventReadonly(event)&quot; @input=&quot;emitField('input', event)&quot; @change=&quot;emitField('change', event)&quot; @focus=&quot;emitField('focus', event)&quot; @blur=&quot;emitField('blur', event)&quot; @invalid=&quot;emitField('invalid', event)&quot; /&gt;
        &lt;span class=&quot;wire-next__choice-copy&quot;&gt;
        &lt;strong&gt;&#123;option.label&#125;&lt;/strong&gt;&#123;#if option.description&#125;&lt;small&gt;&#123;option.description&#125;&lt;/small&gt;&#123;/if&#125;&lt;/span&gt;
        &lt;/label&gt;
          &#123;/each&#125;
        &lt;/div&gt;
      &#123;:else&#125;
        &lt;label class=&quot;wire-next__choice wire-next--checkbox&quot; for=&quot;&#123;id || name&#125;&quot; data-variant=&quot;&#123;variant&#125;&quot; data-icon-position=&quot;&#123;iconPosition&#125;&quot;&gt;
        &lt;input id=&quot;&#123;id || name&#125;&quot; type=&quot;checkbox&quot; name=&quot;&#123;name&#125;&quot; value=&quot;&#123;value&#125;&quot; checked=&quot;&#123;checked&#125;&quot; disabled=&quot;&#123;disabled&#125;&quot; required=&quot;&#123;required&#125;&quot; readonly=&quot;&#123;readonly&#125;&quot; aria-checked=&quot;&#123;indeterminate ? 'mixed' : (checked ? 'true' : 'false')&#125;&quot; aria-invalid=&quot;&#123;error ? 'true' : 'false'&#125;&quot; @click=&quot;preventReadonly(event)&quot; @input=&quot;emitField('input', event)&quot; @change=&quot;emitField('change', event)&quot; @focus=&quot;emitField('focus', event)&quot; @blur=&quot;emitField('blur', event)&quot; @invalid=&quot;emitField('invalid', event)&quot; /&gt;
          &#123;#if icon&#125;&lt;span class=&quot;&#123;icon&#125;&quot; aria-hidden=&quot;true&quot;&gt;
        &lt;/span&gt;&#123;/if&#125;
          &lt;span class=&quot;&#123;hiddenLabel || cornerHint ? 'wire-next__sr-only' : ''&#125;&quot;&gt;&#123;label&#125;&lt;/span&gt;
        &lt;/label&gt;
      &#123;/if&#125;
      &#123;#if helperText&#125;&lt;small class=&quot;wire-next__field-help&quot;&gt;&#123;helperText&#125;&lt;/small&gt;&#123;/if&#125;&lt;small 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>
  }
}