Skip to main content

Custom field type

By defining proxima:FieldType, you can create custom field types for your team. The created custom field types can be referenced by the custom fields of the application.

Manifest Example

modules:
proxima:FieldType:
- key: custom-field-type
name: Custom Field Type
description: This is a custom field type
type: Custom
dataType: array
resource: field-type-resource
resources:
- key: field-type-resource
path: ./field-type

Properties

PropertyTypeRequiredDescription
keyStringYesThe key of the custom field type, which can be referenced by the fieldType in the proxima:CustomField. It must be unique in the Manifest file. Rule: ^[a-zA-Z0-9_-]+$
nameStringYesName of the custom field type
descriptionStringNoDescription of the custom field type
typeStringYesType: Default is Custom
dataTypeStringYesData type, array for arrays
resourceStringYesThe key pointing to the static resource