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.
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.
- centerAffixboolean
- Vertically center the prepend/append icons relative to the field height.
- dirtyboolean
- Mark the field as dirty (user has interacted with it).
- disabledboolean
- Disable the field, preventing user interaction.
- errorstring | boolean
- Error state: boolean paints the --error modifier; a string also becomes the inline error message.
- inlineboolean
- Render the field inline instead of as a block.
- flatboolean
- Remove the default shadow/elevation from the field.
- labelstring
- Floating label text.
- prefixstring
- Static text prepended inside the field.
- suffixstring
- Static text appended inside the field.
- persistentClearboolean
- Always show the clear button, even when the field is empty.
- singleLineboolean
- Hide the label when the field is focused or filled.
- requiredboolean
- Mark the field as required, adding aria-required and a visual indicator.
- reverseboolean
- Reverse the layout direction of the field.
- activeColorTColor
- activeBgColorTColor
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