Skip to main content

Fields


Fields

The fields section is required when a form component (e.g., IssueForm) is part of the widget. These fields define the input elements in the form and must align with the definition. fields of the form component and the payload of the associated service (e.g., createNewIssue).

"fields": {
"issue_title" : {
"label": "Title",
"data": "title",
"type": "text"
},
"issue_priority" : {
"label": "Priority",
"type": "select",
"options": ["Low", "Medium", "High"]
}
}

Field properties

Prop NameDescriptionData TypeRequiredExample
dataData key to map the field's value to the service payload.stringno"title"
labelDisplay text for the field in the form UI.stringno"Title"
nameUnique identifier for the field, used in form and service payload.stringyes"title"
optionsOptions for select type fields.array stringno["Low", "Medium", "High"]
typeInput type for the form (e.g., text, select).stringno"select" (for issue_priority)