Skip to content

Fields

Built-in field kinds:

KindValueOptions
textstringplaceholder, minLength, maxLength, pattern
numbernumber | nullmin, max, step, unit, placeholder
booleanbooleanrequired requires true
categorystring | nulloptions as strings or { label, value }
mapped-categorystring | nulloptions as { label, value, mapping }. See Mapped Category.
onehot-categorystring | nulloptions as { label, value, mappedTo }. Emits 0/1 one-hot columns. See OneHot Category.
dateDate | nullmin, max, step
seriespoints arrayminPoints, maxPoints, granularity, ordered, uniqueTimestamps, minDate, maxDate, minValue, maxValue, unit

Shared options:

{
id: "email",
kind: "text",
label: "Email",
description: "Used for notifications.",
showDescriptionInline: true,
required: true,
defaultValue: "",
includeInSubmission: true,
mappedTo: "email",
hiddenWhen: { kind: "field-value", field: "anonymous", equals: true },
ui: { autocomplete: "email" }
}

Shared field options also include:

  • showDescriptionInline: Shows description by default instead of waiting for the help button.
  • inactiveFieldPolicy: Controls whether hidden/disabled fields are submitted.
  • includeInSubmission: Set to false to keep a field out of values, fieldValues, serializedValues, and serializedFieldValues.
  • mappedTo: Writes the field to a backend feature name, numeric position, or backend-specific map.
  • valuePath: Writes the field into a nested payload path while keeping flat fieldValues.