Skip to main content

Custom field

By defining proxima:CustomField, you can create custom fields for your team. The created custom fields can be configured on the issue interface.

Manifest Example

modules:
proxima:CustomField:
- key: custom-field
name: Custom Field
description: This is a custom field
fieldType: Text
undeletable: true
locked: true

Properties

PropertyTypeRequiredDescription
keyStringYesThe key of the custom field. It must be unique in the Manifest file. Rule: ^[a-zA-Z0-9_-]+$
nameStringYesName of the custom field
descriptionStringNoDescription of the custom field
fieldTypeStringYesType of the custom field
lockedBooleanNoWhether it is locked, if locked, it cannot be edited
undeletableBooleanNoWhether it can be deleted, if true, it cannot be deleted
dataObjectNoData source for dropdown type fields
propertyObjectNoExtended properties of the custom field

Example of data property usage

modules:
proxima:CustomField:
- key: custom-field
name: Custom Field
description: This is a custom field
fieldType: Dropdown
data:
customData:
- label: label1
value: value1
- label: label2
value: value2
undeletable: true
locked: true

fieldType values

  • Text
  • User
  • LongText
  • Number
  • Dropdown
  • Date
  • DateRange
  • Script

It can also be specified as a custom field type created by proxima:FieldType