IPasswordStrength

interface
Form & Input

Result returned by computeStrength() and consumed by <OrigamPasswordField> to drive the strength bar UI. Carries a numeric score (0..4) and a semantic level identifier.

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

API

Properties

Every property declared by this interface, with its type, optionality and default.

score
required
TPasswordStrengthScore
Numeric score 0..4 — number of bar segments that should fill. Maps 1:1 to the colour tier via level.
level
required
TPasswordStrengthLevel
Colour-tier identifier (weak | fair | good | strong) resolving to the --origam-password-field__strength---bg-{level} token.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Reacting to strength changes

typescript