IPasswordRequirement
interface
Form & Input
Descriptor for one rule shown in the requirements checklist or tile grid of <OrigamPasswordField>. The test() predicate is evaluated reactively against the current password value.
TypeScript
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- idrequiredstring
- Stable identifier used as :key and as data-cy suffix in stories.
- labelrequiredstring
- Human-readable label rendered next to the check/cross icon.
- testrequired(value: string) => boolean
- Predicate evaluated against the current password value. Returns true when the rule is satisfied.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Defining custom password requirements