IConfirmWrapperProps

interface
Form & Input

Full props contract for <OrigamConfirmWrapper> — a "type-it-twice" form helper that pairs a primary input with a confirmation input and lights up only when both values match. Inherits layout, color, density, rounded, elevation, variant and focus mixins.

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.

modelValue
any
Value bound via v-model — the primary input value.
confirm
any
Value of the confirmation input. The wrapper is "confirmed" when modelValue === confirm.
field
string
Field name forwarded to the internal inputs for form libraries (e.g. VeeValidate).
defaults
Record<string, any>
Default prop values injected into the internal input slot components.
confirmLabel
string
Label text rendered on the confirmation input.
disabled
boolean
Disables both inputs and prevents interaction.
readonly
boolean
Makes both inputs read-only.
required
boolean
Marks both inputs as required (triggers native form validation).
error
boolean
Forces the error state on the wrapper.
errorMessages
string | string[]
One or more error messages displayed below the inputs.
hideDetails
boolean | 'auto'
Hides the details/messages row. Set to "auto" to hide it only when there are no messages.
messages
string | string[]
Informational messages displayed in the details area.
hint
string
Hint text shown below the inputs.
persistentHint
boolean
Forces the hint to always be visible (not only on focus).
centerAffix
boolean
Vertically centres the prepend/append affixes instead of aligning them to the top.
label
string
Label text for the primary input.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Password confirmation field

vue