Field Extension

Replace any content form field by your own.

Field Extension declaration propertiesAnchor

KeyTypeDescription
fieldTypeFieldExtensionType (required)What field type is your extension targeting
features[FieldExtensionFeature]] (required)List of features implemented by the extension (at least one)
fieldConfigConfigOptionsDefinitionAdditional instance config options that will be asked for at field setup
listConfigConfigOptionsDefinitionSame, but for the List Renderer
tableConfigConfigOptionsDefinitionSame, but for the Table Renderer

Field Types

Supported FieldExtensionType values:

Typevalue type
STRINGstring
INTnumber (without decimals)
FLOATnumber
BOOLEANboolean
JSONany valid JSON value
DATEstring in format 'yyyy-MM-dd'
DATETIMEstring in ISO 8601 format
LOCATIONobject { "latitude": number; "longitude": number; }
COLORobject { "rgba": { "r": number; "g": number; "b": number; "a": number; } }

Soon to be supported FieldExtensionType values: RICHTEXT, UNION, RELATION, ASSET

Field Extension Features

  • FieldRenderer: The extension replaces a form field.
  • ListRenderer: By enabling this feature, you indicate that the extension can handle array values as well, and that GraphCMS should call it directly instead of the default list renderer on multiple value inputs.
  • TableRenderer (soon): The extension should also be used to display values in the content tables.

Did you find this page useful?

Your feedback helps us improve our docs, and product.