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
Définition
La définition TypeScript de l'interface telle que trouvée dans le code source d'origam. Cliquez sur l'icône de copie pour copier l'extrait.
Héritage
Hérite de
Interfaces parentes dont celle-ci hérite. Leurs propriétés sont disponibles pour tout consommateur de cette interface.
API
Propriétés
Chaque propriété déclarée par cette interface, avec son type, son caractère optionnel et sa valeur par défaut.
- onIconTIcon
- Icon displayed when the password is HIDDEN (clicking reveals the value).
- offIconTIcon
- Icon displayed when the password is VISIBLE (clicking hides the value).
- maxlengthnumber
- Native maxlength attribute mirrored into the requirements popup.
- requirementsboolean
- Master switch for the strength-requirements popup. When false the field behaves exactly like a standard TextField.
- persistentRequirementsboolean
- Keep the requirements popup open even when the field is not focused. Useful for forms that want requirements always visible.
- minLengthnumber
- Minimum password length (default 8). Drives the minLength rule injected automatically.
- needTinyboolean
- Require at least one lowercase letter.
- needUppercaseboolean
- Require at least one uppercase letter.
- needNumberboolean
- Require at least one digit.
- needSpecialboolean
- Require at least one non-alphanumeric character.
- menuPropsIMenuProps
- Props forwarded to the internal <OrigamMenu> (location, delays, etc.).
- menuboolean
- Programmatically controls the requirements menu open/close state.
- strengthBarboolean
- Renders a 4-segment strength bar under the input. Segments fill as the password grows stronger using semantic colour tokens.
- requirementRulesIPasswordRequirement[]
- 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.
- minimalboolean
- Strips every decoration (toggle eye, strength bar, requirements checklist). Useful for confirm-password fields where adornments add noise.
Écosystème
Utilisé par
Composants et composables qui étendent ou consomment cette interface.
Usage
Exemples
Extraits de code prêts à coller utilisant cette interface.
PasswordField with strength bar and requirements