IFieldProps

interface
Form & Input

Full prop surface for OrigamField — controls label, prefix/suffix, error state, disabled/dirty/required flags, and inherits color, density, variant, rounded, elevation, size, loader, focus and adjacent-inner 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
Vertically center the prepend/append icons relative to the field height.
dirty
boolean
Mark the field as dirty (user has interacted with it).
disabled
boolean
Disable the field, preventing user interaction.
error
string | boolean
Error state: boolean paints the --error modifier; a string also becomes the inline error message.
inline
boolean
Render the field inline instead of as a block.
flat
boolean
Remove the default shadow/elevation from the field.
label
string
Floating label text.
prefix
string
Static text prepended inside the field.
suffix
string
Static text appended inside the field.
persistentClear
boolean
Always show the clear button, even when the field is empty.
singleLine
boolean
Hide the label when the field is focused or filled.
required
boolean
Mark the field as required, adding aria-required and a visual indicator.
reverse
boolean
Reverse the layout direction of the field.
activeColor
TColor
activeBgColor
TColor

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Field with error state and label

vue