Skip to content

Settings every field has ​

Open a field in the fieldset editor and its settings are split into tabs. The first tab is always the same: the settings every field shares. Type-specific settings come after them.

Label, key and description ​

  • Label is what editors see above the field. Change it whenever you like.
  • Key is where the value is stored. It is suggested from the label when you create the field. Once content has been saved, treat it as permanent; see Field keys.
  • Description is help text for editors. The fieldset's Display field description as setting shows it as a tooltip beside the label or as a line of text under it.

Placeholder and default value ​

Most input fields have a Placeholder, grey hint text shown while the field is empty and never saved, and a Default value, which is filled in on new entries.

A default value only applies to entries created after you set it. Existing entries keep whatever they have, including nothing.

Prefix and suffix ​

Text and Number fields can show a short Prefix or Suffix beside the input: € before a price, kg after a weight, # before an ID. They're display-only. The stored value stays 49, not €49, which keeps it usable for sorting and calculations.

Use them instead of putting the unit in the label ("Price (€)") or adding a separate field for it.

Extra tabs ​

Depending on its type, a field may have more tabs:

TabOnWhat it's for
Sub FieldsGroup, RepeaterThe fields inside the container.
ColumnsField TableThe table's columns.
LayoutsContent sectionsThe kinds of section editors can add.
Conditional LogicEvery field that stores dataShow or hide this field based on other fields. See Conditional logic.
REST APIEvery field that stores dataWhether the value is exposed over the REST API. See below.

REST API access ​

Every data field has an Access setting for the REST API: Inherit from fieldset, Public, Authenticated or Private, plus an optional REST key to publish the value under a different name. Inherit uses the fieldset's REST API default field access, which is Private unless you change it.

No required fields ​

VX fields have no "required" setting. Saves are never blocked by an empty field. See Saving and validation.

Technical details for LLMs
  • Base config keys (every data field): type, key (1–64 chars), label (1–200 chars), description, width, responsive_widths: { medium, wide }, conditional_logic. required is accepted but not enforced.
  • REST keys (every data field): rest: { access: "inherit"|"public"|"authenticated"|"private", rest_key (max 64) }.
  • Common type keys: placeholder, default_value, prefix / suffix (text, number; display-only, not stored). Range slider has value_prefix for the displayed values.
  • Layout types (ui_*) have no description, and store nothing.
  • Change one field with vx-framework/update-field (fieldset, field_key, a partial config); don't resend the whole fieldset.

Documentation for the VX Framework.