Skip to main content
Version: v2.0.0-rc6

DropdownResponse

Defined in: parser/types.ts:360

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?",
"location": "aboveStimulus",
"type": "dropdown",
"placeholder": "Please choose your favorite color",
"options": ["Red", "Blue"]
}

Extends

Properties

PropertyTypeDescriptionInherited fromDefined in
hidden?booleanControls whether the response is hidden.BaseResponse.hiddenparser/types.ts:183
idstringThe id of the response. This is used to identify the response in the data file.BaseResponse.idparser/types.ts:167
location?"sidebar" | "aboveStimulus" | "belowStimulus"Controls the response location. These might be the same for all responses, or differ across responses. Defaults to belowStimulusBaseResponse.locationparser/types.ts:175
options(string | StringOption)[]The options that are displayed in the dropdown.-parser/types.ts:365
paramCapture?stringUse 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.paramCaptureparser/types.ts:181
placeholder?stringThe placeholder text that is displayed in the input.-parser/types.ts:363
promptstringThe prompt that is displayed to the participant. You can use markdown here to render images, links, etc.BaseResponse.promptparser/types.ts:169
required?booleanControls whether the response is required to be answered. Defaults to true.BaseResponse.requiredparser/types.ts:173
requiredLabel?stringYou can provide a required label, which makes it so a participant has to answer with a response that matches label.BaseResponse.requiredLabelparser/types.ts:179
requiredValue?unknownYou can provide a required value, which makes it so a participant has to answer with that value.BaseResponse.requiredValueparser/types.ts:177
secondaryText?stringThe secondary text that is displayed to the participant under the prompt. This does not accept markdown.BaseResponse.secondaryTextparser/types.ts:171
type"dropdown"--parser/types.ts:361
withDivider?booleanRenders the response with a trailing divider.BaseResponse.withDividerparser/types.ts:185
withDontKnow?booleanRenders the response with an option for "I don't know". This counts as a completed answer for the validation.BaseResponse.withDontKnowparser/types.ts:187