...
Name | Type | Description |
|---|---|---|
name | string | The name by which the field will internally be referenced |
displayText | string | The main field label displayed above the field |
description | string | An additional description displayed below the main label |
defaultValue | string | The value the field should initially be filled with. This field needs to be a valid id of an existing entry. |
options | object | Additional field options (see below) |
options.required | boolean | Whether the field must be filled to advance |
options.readOnly | boolean | Whether it’s allowed to change the field value |
options.confirmation | boolean | Whether to include this field in the confirmation page |
options.sectionId | string | Optionally restrict the allowed entries to a specific section. |
options.primaryFieldKey | string | The key that should be used to retrieve the primary text field (shown above in the option list as the black text). Falls back to the entries |
options.secondaryFieldKey | string or string[] | The key that should be used for the secondary text field (shown above as the gray text). If empty, no secondary field will be used. If an array is passed, multiple values can be displayed. |
...