Skip to content
  1. Extras
  2. PageBuilder
  3. Field types

Field types reference

30 types in Free and 20 in Pro. Pro is enabled with capability advanced-fields. Each type page has Why this type, When to use, Tips, Similar types, JSON Schema, a Section data block, a Fenom example, and Common properties.

Common meta keys (tab, width, description, default, active): overview.

Free

typeLayerPageOutput and example
textFreetextJSON and Fenom
textareaFreetextareaJSON and Fenom
richtextFreerichtextJSON and Fenom
aceFreeaceJSON and Fenom
numberFreenumberJSON and Fenom
urlFreeurlJSON and Fenom
slugFreeslugJSON and Fenom
selectFreeselectJSON and Fenom
multiselectFreemultiselectJSON and Fenom
radioFreeradioJSON and Fenom
checkboxFreecheckboxJSON and Fenom
checkboxgroupFreecheckboxgroupJSON and Fenom
yesnoFreeyesnoJSON and Fenom
toggleFreetoggleJSON and Fenom
dateFreedateJSON and Fenom
timeFreetimeJSON and Fenom
datetimeFreedatetimeJSON and Fenom
colorFreecolorJSON and Fenom
colorpaletteFreecolorpaletteJSON and Fenom
fileFreefileJSON and Fenom
imageFreeimageJSON and Fenom
videoFreevideoJSON and Fenom
buttonFreebuttonJSON and Fenom
resourcelistFreeresourcelistJSON and Fenom
hiddenFreehiddenJSON and Fenom
readonlyFreereadonlyJSON and Fenom
xtypeFreextypeJSON and Fenom
headingFreeheadingJSON and Fenom
repeaterFreerepeaterJSON and Fenom
editorjsFreeeditorjsJSON and Fenom

Pro

typeLayerPageOutput and example
relationProrelationJSON and Fenom
multirelationPromultirelationJSON and Fenom
galleryProgalleryJSON and Fenom
mapPromapJSON and Fenom
tableProtableJSON and Fenom
embeddedTableProembeddedTableJSON and Fenom
keyvalueProkeyvalueJSON and Fenom
tagProtagJSON and Fenom
currencyProcurrencyJSON and Fenom
imaskProimaskJSON and Fenom
comboProcomboJSON and Fenom
multicomboPromulticomboJSON and Fenom
tablecomboProtablecomboJSON and Fenom
tablemulticomboProtablemulticomboJSON and Fenom
fieldsetProfieldsetJSON and Fenom
dependentProdependentJSON and Fenom
tvProtvJSON and Fenom
chunkProchunkJSON and Fenom
snippetProsnippetJSON and Fenom
jsongridProjsongridJSON and Fenom

Composite scenarios

showWhen

The field is visible when another field matches value (not equals).

json
{
  "name": "extra_url",
  "type": "url",
  "label": "Extra link",
  "showWhen": { "field": "show_extra", "value": true }
}

Implementation: fieldVisibility.ts.

optionsSource

json
{
  "name": "template",
  "type": "tablecombo",
  "label": "Template",
  "optionsSource": {
    "class": "modTemplate",
    "valueField": "id",
    "labelField": "templatename",
    "limit": 100
  }
}

Processor: mgr/field/options. Hook: pbOnFieldValues.

Resource tables

Use the resource Tables tab or Collections tab type table. Field embeddedTable stores table_key and query options. See table settings and CMP.

Aliases

Full list in FIELD_TYPE_ALIASES (fieldDefaults.ts). Common: relationshiprelation, resourcesresourcelist, boolean / listyesnoyesno, onlyreadingreadonly, colorpickercolor, editor_jseditorjs.

See also