IInputProps

interface
Form & Input

Props contract for OrigamInput — the foundational input wrapper. Aggregates density, spacing, rounding, color, border, elevation, dimension, direction, validation, adjacent-slot, and size surfaces.

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.

centerAffix
boolean
Center the prepend/append affix icons vertically in the input.
hideDetails
boolean | string
Hide hint and validation messages. Pass "auto" to hide only when no message is present.
hideSpinButtons
boolean
Hide the native browser spin buttons on number inputs.
hint
string
Helper text shown below the input.
persistentHint
boolean
Always show the hint text, even when the input is not focused.
messages
Array<string> | string
Validation or status messages to display below the input.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Input with hint and validation messages

vue