models/joyfill.dropdown/DropdownField

DropdownField

interface DropdownField : Field, DropdownComponent

Field that allows users to select a single value from a predefined list.

Combines the generic Field behavior with DropdownComponent to provide a compact selector UI. Useful when the set of valid values is known and constrained, improving data quality and user efficiency.

Implementations support searching if options contain more than 20 elements are based on Field logic.

Properties

Link copied to clipboard
abstract val disabled: Boolean

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

Link copied to clipboard
abstract val formulas: MutableList<FormularApplication>

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

Link copied to clipboard
abstract var hidden: Boolean

Whether the element is hidden by default.

Link copied to clipboard
abstract var id: String

Stable identifier of this schema node.

Link copied to clipboard
abstract var identifier: String

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

Link copied to clipboard
abstract val initialHiddenState: Boolean

Whether the field starts hidden before any logic evaluation occurs.

Link copied to clipboard
abstract val logic: FieldLogic?

Optional FieldLogic describing visibility logic for the field

Link copied to clipboard
abstract val metadata: JoyMap

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

Link copied to clipboard
abstract val options: List<Option>

The full list of selectable Option entries presented to the user.

Link copied to clipboard
abstract var required: Boolean

Whether a value is mandatory for this schema.

Link copied to clipboard
abstract val tip: ToolTip?

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

Link copied to clipboard
abstract var title: String

Human-readable label used in editors or viewers.

Link copied to clipboard
abstract var type: Type

Discriminant describing the concrete schema/component kind.

Link copied to clipboard
abstract val value: Any?

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

Functions

Link copied to clipboard
abstract fun toJsonObject(): JsonObject

Serializes this instance to a structured JsonObject.

Link copied to clipboard
abstract fun toJsonString(): String

Serializes this instance to a compact JSON string.

Link copied to clipboard
abstract fun toMap(): MutableMap<String, Any?>

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