Field Extension Declaration

Field Extension declaration propertiesAnchor

KeyTypeDescription
extensionTypefield (required)The type of extension
fieldTypeFieldExtensionType (required)What field type is your extension targeting
features[FieldExtensionFeature] (required)List of features implemented by the extension (at least one)
fieldConfigConfigFieldsOptional definition of field configuration settings. Supports the following field types: string, number, and boolean

FieldExtensionType enumerationAnchor

Supported FieldExtensionType enumeration 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

FieldExtensionFeature enumerationAnchor

  • 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 Hygraph should call it directly instead of the default list renderer on multiple value inputs.
  • TableRenderer: The extension should also be used to display values in the content table.