IFieldDefaultSlotProps

interface
Slots

Shape of the slot props injected into the default slot of OrigamField — exposes the id, aria-describedby, active/focused state, ref and focus handlers so inner input elements can wire up correctly.

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

API

Properties

Every property declared by this interface, with its type, optionality and default.

id
required
string
Unique DOM id generated by OrigamField for the inner input.
'aria-describedby'
required
string
isActive
required
boolean
True when the field is in an active (non-empty / focused) state.
isFocused
required
boolean | undefined
True when the inner input is focused.
ref
required
HTMLElement | undefined
Template ref to the underlying input element managed by OrigamField.
onBlur
required
() => void
Blur handler to be bound on the inner native input.
onFocus
required
() => void
Focus handler to be bound on the inner native input.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Wiring a native input inside OrigamField

vue