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