DropdownResponse
The DropdownResponse interface is used to define the properties of a dropdown response. DropdownResponses render as a select input with user specified options.
Example:
{
"id": "q-color",
"prompt": "What is your favorite color?",
"required": true,
"location": "aboveStimulus",
"type": "dropdown",
"placeholder": "Please choose your favorite color",
"options": [
{
"label": "Red",
"value": "red"
},
{
"label": "Blue",
"value": "blue"
}
]
}
Extends
Properties
Property | Type | Description | Inherited from |
---|---|---|---|
hidden? | boolean | Controls whether the response is hidden. | BaseResponse .hidden |
id | string | The id of the response. This is used to identify the response in the data file. | BaseResponse .id |
location? | "sidebar" | "aboveStimulus" | "belowStimulus" | Controls the response location. These might be the same for all responses, or differ across responses. Defaults to belowStimulus | BaseResponse .location |
options | StringOption [] | The options that are displayed in the dropdown. | - |
paramCapture? | string | Use to capture querystring parameters in answers such as participant_name. See the examples for how this is used, but prefer uiConfig.urlParticipantIdParam if you are capturing a participant ID. | BaseResponse .paramCapture |
placeholder? | string | The placeholder text that is displayed in the input. | - |
prompt | string | The prompt that is displayed to the participant. You can use markdown here to render images, links, etc. | BaseResponse .prompt |
required | boolean | Controls whether the response is required to be answered. | BaseResponse .required |
requiredLabel? | string | You can provide a required label, which makes it so a participant has to answer with a response that matches label. | BaseResponse .requiredLabel |
requiredValue? | unknown | You can provide a required value, which makes it so a participant has to answer with that value. | BaseResponse .requiredValue |
secondaryText? | string | The secondary text that is displayed to the participant under the prompt. This does not accept markdown. | BaseResponse .secondaryText |
type | "dropdown" | - | - |