IPasswordFieldProps

interface
Form & Input

Props contract for <OrigamPasswordField>. Extends ITextFieldProps with show/hide toggle icons, strength bar, configurable requirements checklist and a minimal mode that strips all adornments.

TypeScript

Definition

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

typescript

Inheritance

Extends

Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.

API

Properties

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

onIcon
TIcon
Icon displayed when the password is HIDDEN (clicking reveals the value).
offIcon
TIcon
Icon displayed when the password is VISIBLE (clicking hides the value).
maxlength
number
Native maxlength attribute mirrored into the requirements popup.
requirements
boolean
Master switch for the strength-requirements popup. When false the field behaves exactly like a standard TextField.
persistentRequirements
boolean
Keep the requirements popup open even when the field is not focused. Useful for forms that want requirements always visible.
minLength
number
Minimum password length (default 8). Drives the minLength rule injected automatically.
needTiny
boolean
Require at least one lowercase letter.
needUppercase
boolean
Require at least one uppercase letter.
needNumber
boolean
Require at least one digit.
needSpecial
boolean
Require at least one non-alphanumeric character.
menuProps
IMenuProps
Props forwarded to the internal <OrigamMenu> (location, delays, etc.).
menu
boolean
Programmatically controls the requirements menu open/close state.
strengthBar
boolean
Renders a 4-segment strength bar under the input. Segments fill as the password grows stronger using semantic colour tokens.
requirementRules
IPasswordRequirement[]
Inline requirements checklist. Pass an array of IPasswordRequirement predicates. Falls back to DEFAULT_PASSWORD_REQUIREMENTS when requirements=true and this is omitted.
requirementsLayout
'list' | 'tiles'
Layout for the requirements checklist — "list" (default) vertical ul/li rows, or "tiles" OrigamChip pills.
minimal
boolean
Strips every decoration (toggle eye, strength bar, requirements checklist). Useful for confirm-password fields where adornments add noise.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

PasswordField with strength bar and requirements

html