Dropdown Block Addon (dropdownBlockAddon)
The purpose of this block is to display an interactive dropdown menu in the interfaceDocumentsSourceBlock.
Usage
As shown in the example below, dropdownBlockAddon blocks should be placed inside interfaceDocumentsSourceBlock blocks. Source addons, which return documents for the dropdown, should be placed inside dropdownBlockAddon.
Properties
Property Name | Description | Example | Status |
---|---|---|---|
Option Name (optionName) | The label (name) which is shown in dropdown items. | document.credentialSubject.0.field0 | |
Option Value (optionValue) | The value which will be used when a specific item is clicked. | document.credentialSubject.0.id | |
Field (field) | The field in selected document which will be populated with the option value. | assignedTo |
Events
Dropdown block addon events will be automatically added to document source.
API
The API for the dropdownBlockAddon has both GET and POST methods:
Example response to the GET request:
A response to the GET request includes all block settings and:
โ documents - Dropdown options
Example payload for the POST request:
โ documentId - Selected document
โ dropdownDocumentId - Dropdown item which was clicked
Last updated