ITextFieldProps

interface
Forms & Inputs

Full prop surface for <OrigamTextField> — extends field, input, color, density, padding/margin, border, rounded and elevation contracts, with autofocus, counter, placeholder, input type and mask support.

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.

autofocus
boolean
Focuses the input on mount.
counter
boolean | number | string
Shows a character counter. Pass a number to set the max displayed value.
counterValue
number | ((e: any) => number)
Custom function or fixed number for calculating the counter value.
placeholder
string
Placeholder text shown inside the input when it has no value.
persistentPlaceholder
boolean
Keeps the placeholder visible even when a value is set.
persistentCounter
boolean
Keeps the counter visible even when the input is not focused.
role
string
ARIA role override for the input element.
type
TTextFieldType
HTML input type. Defaults to 'text'.
modelModifiers
string | boolean
Vue model modifiers applied to the v-model binding.
mask
TMask
Input mask — built-in preset ('phone:fr'), raw pattern or options object. v-model receives the unmasked value.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Phone input with mask and counter

html