models/joyfill.text/TextField

TextField

interface TextField : Field, TextComponent

Single-line text input field.

Combines the core Field contract with TextComponent to capture short strings such as names, titles, and identifiers.

Properties

disabled

abstract val disabled: Boolean

Whether this field is non-interactive (read-only/disabled) for the end user.

formulas

abstract val formulas: MutableList<FormularApplication>

Collection of formulas applied to this field. Order may determine execution precedence.

hidden

abstract var hidden: Boolean

Whether the element is hidden by default.

abstract var id: String

Stable identifier of this schema node.

identifier

abstract var identifier: String

Unique key that identifies this field within a document. Must be stable across updates.

initialHiddenState

abstract val initialHiddenState: Boolean

Whether the field starts hidden before any logic evaluation occurs.

logic

abstract val logic: FieldLogic?

Optional FieldLogic describing visibility logic for the field

metadata

abstract val metadata: JoyMap

Arbitrary key-value map for custom extensions or analytics. Persisted alongside the field.

required

abstract var required: Boolean

Whether a value is mandatory for this schema.

tip

abstract val tip: ToolTip?

Optional ToolTip to assists users with context, instructions, or hints.

title

abstract var title: String

Human-readable label used in editors or viewers.

type

abstract var type: Type

Discriminant describing the concrete schema/component kind.

value

abstract val value: Any?

Runtime value payload; variance is specialized by sub-interfaces.

Functions

toJsonObject

abstract fun toJsonObject(): JsonObject

Serializes this instance to a structured JsonObject.

toJsonString

abstract fun toJsonString(): String

Serializes this instance to a compact JSON string.

toMap

abstract fun toMap(): MutableMap<String, Any?>

Converts this instance into a mutable key-value map suitable for mutation and re-serialization.