Files
WRNexusJSDoc/app/pages/components/strong-password.wrn
T

265 lines
18 KiB
Plaintext

page StrongPasswordcomponent {
seo {
title = "StrongPassword component"
description = "Theme-aware, responsive strong password 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.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">StrongPassword</span></nav><section class="doc-intro"><span class="eyebrow">advanced-forms component</span><h1>StrongPassword</h1><p>Theme-aware, responsive strong password component.</p><div class="doc-meta"><span>@wrnexus/ui 0.4.0</span><span>27 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;StrongPassword
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;StrongPassword&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;Create a strong password&quot;</code></td></tr><tr><td><code>autocomplete</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;new-password&quot;</code></td></tr><tr><td><code>minLength</code></td><td><code>number</code></td><td>Optional</td><td><code>8</code></td></tr><tr><td><code>specialCharactersSet</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;!@#$%^&amp;*()_+-=[]&#123;&#125;|;:,.&lt;&gt;?&quot;</code></td></tr><tr><td><code>requireLowercase</code></td><td><code>boolean</code></td><td>Optional</td><td><code>true</code></td></tr><tr><td><code>requireUppercase</code></td><td><code>boolean</code></td><td>Optional</td><td><code>true</code></td></tr><tr><td><code>requireNumber</code></td><td><code>boolean</code></td><td>Optional</td><td><code>true</code></td></tr><tr><td><code>requireSpecialCharacter</code></td><td><code>boolean</code></td><td>Optional</td><td><code>true</code></td></tr><tr><td><code>showRequirements</code></td><td><code>boolean</code></td><td>Optional</td><td><code>true</code></td></tr><tr><td><code>presentation</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;inline&quot;</code></td></tr><tr><td><code>hintText</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;Use a unique password you do not use elsewhere.&quot;</code></td></tr><tr><td><code>emptyLabel</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;Enter a password&quot;</code></td></tr><tr><td><code>weakLabel</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;Weak&quot;</code></td></tr><tr><td><code>fairLabel</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;Fair&quot;</code></td></tr><tr><td><code>goodLabel</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;Good&quot;</code></td></tr><tr><td><code>strongLabel</code></td><td><code>string</code></td><td>Optional</td><td><code>&quot;Strong&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>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>strength</code></li></ul></section><section id="source"><h2>Source contract</h2><p>Installed source: <code>components/StrongPassword.wrn</code></p><pre data-language="wrn"><code>component StrongPassword &#123;
props &#123;
size = &quot;default&quot;
color = &quot;primary&quot;
label = &quot;Password&quot;
name = &quot;password&quot;
value = &quot;&quot;
placeholder = &quot;Create a strong password&quot;
autocomplete = &quot;new-password&quot;
minLength = 8
specialCharactersSet = &quot;!@#$%^&amp;*()_+-=[]&#123;&#125;|;:,.&lt;&gt;?&quot;
requireLowercase = true
requireUppercase = true
requireNumber = true
requireSpecialCharacter = true
showRequirements = true
presentation = &quot;inline&quot;
hintText = &quot;Use a unique password you do not use elsewhere.&quot;
emptyLabel = &quot;Enter a password&quot;
weakLabel = &quot;Weak&quot;
fairLabel = &quot;Fair&quot;
goodLabel = &quot;Good&quot;
strongLabel = &quot;Strong&quot;
disabled = false
readonly = false
required = false
invalid = false
validationMessage = &quot;&quot;
class = &quot;&quot;
@event input = function
@event change = function
@event strength = function
&#125;
state password = value
state detailsOpen = false
functions &#123;
function hasMinimumLength() &#123;
return password.length &gt;= Number(minLength)
&#125;
function hasLowercase() &#123;
return password !== password.toUpperCase()
&#125;
function hasUppercase() &#123;
return password !== password.toLowerCase()
&#125;
function hasNumber() &#123;
return containsCharacterAt(&quot;0123456789&quot;, 0)
&#125;
function hasSpecialCharacter() &#123;
return containsCharacterAt(specialCharactersSet, 0)
&#125;
function containsCharacterAt(characters, index) &#123;
if (index &gt;= characters.length) &#123;
return false
&#125;
if (password.includes(characters[index])) &#123;
return true
&#125;
return containsCharacterAt(characters, index + 1)
&#125;
function score() &#123;
return (hasMinimumLength() ? 1 : 0) + (requireLowercase &amp;&amp; hasLowercase() ? 1 : 0) + (requireUppercase &amp;&amp; hasUppercase() ? 1 : 0) + (requireNumber &amp;&amp; hasNumber() ? 1 : 0) + (requireSpecialCharacter &amp;&amp; hasSpecialCharacter() ? 1 : 0)
&#125;
function maximumScore() &#123;
return 1 + (requireLowercase ? 1 : 0) + (requireUppercase ? 1 : 0) + (requireNumber ? 1 : 0) + (requireSpecialCharacter ? 1 : 0)
&#125;
function strengthPercent() &#123;
return Math.round(score() / maximumScore() * 100)
&#125;
function strengthLevel() &#123;
if (!password) &#123;
return &quot;empty&quot;
&#125;
if (strengthPercent() &lt;= 25) &#123;
return &quot;weak&quot;
&#125;
if (strengthPercent() &lt;= 50) &#123;
return &quot;fair&quot;
&#125;
if (strengthPercent() &lt; 100) &#123;
return &quot;good&quot;
&#125;
return &quot;strong&quot;
&#125;
function strengthLabel() &#123;
if (strengthLevel() === &quot;weak&quot;) &#123;
return weakLabel
&#125;
if (strengthLevel() === &quot;fair&quot;) &#123;
return fairLabel
&#125;
if (strengthLevel() === &quot;good&quot;) &#123;
return goodLabel
&#125;
if (strengthLevel() === &quot;strong&quot;) &#123;
return strongLabel
&#125;
return emptyLabel
&#125;
&#125;
view &#123;
&lt;div
class=&quot;wire-next wire-next--color-&#123;color&#125; wire-next--size-&#123;size&#125; wire-next--strong-password wire-next--strong-password-&#123;presentation&#125; &#123;invalid ? 'wire-next--invalid' : ''&#125; &#123;disabled ? 'wire-next--disabled' : ''&#125; &#123;class&#125;&quot;
data-wrn-strong-password
data-strength=&quot;&#123;password ? strengthLevel() : 'empty'&#125;&quot;
data-score=&quot;&#123;password ? score() : 0&#125;&quot;
&gt;
&lt;label for=&quot;&#123;name&#125;-strong-password&quot;&gt;&#123;label&#125;&lt;/label&gt;
&lt;div class=&quot;wire-next__strong-password-anchor&quot;&gt;
&lt;input
&#123;...attrs&#125;
id=&quot;&#123;name&#125;-strong-password&quot;
type=&quot;password&quot;
name=&quot;&#123;name&#125;&quot;
value=&quot;&#123;password&#125;&quot;
placeholder=&quot;&#123;placeholder&#125;&quot;
autocomplete=&quot;&#123;autocomplete&#125;&quot;
minlength=&quot;&#123;minLength&#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' : hintText ? name + '-hint' : ''&#125;&quot;
@focus=&quot;detailsOpen = true&quot;
@blur=&quot;detailsOpen = false&quot;
@input=&quot;password = event.target.value; $emit('input', &#123; value: password, score: score(), maximumScore: maximumScore(), percent: strengthPercent(), level: strengthLevel() &#125;); $emit('strength', &#123; value: password, score: score(), maximumScore: maximumScore(), percent: strengthPercent(), level: strengthLevel() &#125;)&quot;
@change=&quot;$emit('change', &#123; value: password, score: score(), maximumScore: maximumScore(), percent: strengthPercent(), level: strengthLevel() &#125;)&quot;
/&gt;
&#123;#if presentation === &quot;popover&quot;&#125;
&lt;div
class=&quot;wire-next__strong-password-popover&quot;
data-open=&quot;&#123;detailsOpen ? 'true' : 'false'&#125;&quot;
role=&quot;status&quot;
&gt;
&lt;div class=&quot;wire-next__strong-password-popover-arrow&quot; aria-hidden=&quot;true&quot;&gt;
&lt;/div&gt;
&lt;div class=&quot;wire-next__strong-password-details&quot;&gt;
&lt;div class=&quot;wire-next__strong-password-summary&quot;&gt;
&lt;span&gt;Password strength&lt;/span&gt;
&lt;strong&gt;&#123;password ? strengthLabel() : emptyLabel&#125;&lt;/strong&gt;
&lt;/div&gt;
&lt;div
class=&quot;wire-next__strong-password-meter&quot;
role=&quot;progressbar&quot;
aria-label=&quot;Password strength&quot;
aria-valuemin=&quot;0&quot;
aria-valuemax=&quot;100&quot;
aria-valuenow=&quot;&#123;password ? strengthPercent() : 0&#125;&quot;
&gt;
&lt;span style=&quot;width: &#123;password ? strengthPercent() : 0&#125;%&quot;&gt;
&lt;/span&gt;
&lt;/div&gt;
&#123;#if showRequirements&#125;
&lt;ul class=&quot;wire-next__strong-password-requirements&quot;&gt;
&lt;li data-met=&quot;&#123;password &amp;&amp; hasMinimumLength() ? 'true' : 'false'&#125;&quot;&gt;
&lt;span aria-hidden=&quot;true&quot;&gt;
&lt;/span&gt;At least &#123;minLength&#125; characters
&lt;/li&gt;
&#123;#if requireLowercase&#125;&lt;li data-met=&quot;&#123;password &amp;&amp; hasLowercase() ? 'true' : 'false'&#125;&quot;&gt;
&lt;span aria-hidden=&quot;true&quot;&gt;
&lt;/span&gt;One lowercase letter&lt;/li&gt;&#123;/if&#125;
&#123;#if requireUppercase&#125;&lt;li data-met=&quot;&#123;password &amp;&amp; hasUppercase() ? 'true' : 'false'&#125;&quot;&gt;
&lt;span aria-hidden=&quot;true&quot;&gt;
&lt;/span&gt;One uppercase letter&lt;/li&gt;&#123;/if&#125;
&#123;#if requireNumber&#125;&lt;li data-met=&quot;&#123;password &amp;&amp; hasNumber() ? 'true' : 'false'&#125;&quot;&gt;
&lt;span aria-hidden=&quot;true&quot;&gt;
&lt;/span&gt;One number&lt;/li&gt;&#123;/if&#125;
&#123;#if requireSpecialCharacter&#125;&lt;li data-met=&quot;&#123;password &amp;&amp; hasSpecialCharacter() ? 'true' : 'false'&#125;&quot;&gt;
&lt;span aria-hidden=&quot;true&quot;&gt;
&lt;/span&gt;One special character: &#123;specialCharactersSet&#125;&lt;/li&gt;&#123;/if&#125;
&lt;/ul&gt;
&#123;/if&#125;
&#123;#if hintText&#125;&lt;small id=&quot;&#123;name&#125;-hint&quot;&gt;&#123;hintText&#125;&lt;/small&gt;&#123;/if&#125;
&lt;/div&gt;
&lt;/div&gt;
&#123;/if&#125;
&lt;/div&gt;
&#123;#if presentation !== &quot;popover&quot;&#125;
&lt;div class=&quot;wire-next__strong-password-details&quot;&gt;
&lt;div class=&quot;wire-next__strong-password-summary&quot;&gt;
&lt;span&gt;Password strength&lt;/span&gt;
&lt;strong&gt;&#123;password ? strengthLabel() : emptyLabel&#125;&lt;/strong&gt;
&lt;/div&gt;
&lt;div
class=&quot;wire-next__strong-password-meter&quot;
role=&quot;progressbar&quot;
aria-label=&quot;Password strength&quot;
aria-valuemin=&quot;0&quot;
aria-valuemax=&quot;100&quot;
aria-valuenow=&quot;&#123;password ? strengthPercent() : 0&#125;&quot;
&gt;
&lt;span style=&quot;width: &#123;password ? strengthPercent() : 0&#125;%&quot;&gt;
&lt;/span&gt;
&lt;/div&gt;
&#123;#if showRequirements&#125;
&lt;ul class=&quot;wire-next__strong-password-requirements&quot;&gt;
&lt;li data-met=&quot;&#123;password &amp;&amp; hasMinimumLength() ? 'true' : 'false'&#125;&quot;&gt;
&lt;span aria-hidden=&quot;true&quot;&gt;
&lt;/span&gt;At least &#123;minLength&#125; characters&lt;/li&gt;
&#123;#if requireLowercase&#125;&lt;li data-met=&quot;&#123;password &amp;&amp; hasLowercase() ? 'true' : 'false'&#125;&quot;&gt;
&lt;span aria-hidden=&quot;true&quot;&gt;
&lt;/span&gt;One lowercase letter&lt;/li&gt;&#123;/if&#125;
&#123;#if requireUppercase&#125;&lt;li data-met=&quot;&#123;password &amp;&amp; hasUppercase() ? 'true' : 'false'&#125;&quot;&gt;
&lt;span aria-hidden=&quot;true&quot;&gt;
&lt;/span&gt;One uppercase letter&lt;/li&gt;&#123;/if&#125;
&#123;#if requireNumber&#125;&lt;li data-met=&quot;&#123;password &amp;&amp; hasNumber() ? 'true' : 'false'&#125;&quot;&gt;
&lt;span aria-hidden=&quot;true&quot;&gt;
&lt;/span&gt;One number&lt;/li&gt;&#123;/if&#125;
&#123;#if requireSpecialCharacter&#125;&lt;li data-met=&quot;&#123;password &amp;&amp; hasSpecialCharacter() ? 'true' : 'false'&#125;&quot;&gt;
&lt;span aria-hidden=&quot;true&quot;&gt;
&lt;/span&gt;One special character: &#123;specialCharactersSet&#125;&lt;/li&gt;&#123;/if&#125;
&lt;/ul&gt;
&#123;/if&#125;
&#123;#if hintText&#125;&lt;small id=&quot;&#123;name&#125;-hint&quot;&gt;&#123;hintText&#125;&lt;/small&gt;&#123;/if&#125;
&lt;/div&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;/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.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>
}
}