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
Property | Type | Description | Inherited from | Defined in |
---|---|---|---|---|
hidden? | boolean | Controls whether the response is hidden. | BaseResponse .hidden | parser/types.ts:183 |
id | string | The id of the response. This is used to identify the response in the data file. | BaseResponse .id | parser/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 belowStimulus | BaseResponse .location | parser/types.ts:175 |
options | (string | StringOption )[] | The options that are displayed in the dropdown. | - | parser/types.ts:365 |
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 | parser/types.ts:181 |
placeholder? | string | The placeholder text that is displayed in the input. | - | parser/types.ts:363 |
prompt | string | The prompt that is displayed to the participant. You can use markdown here to render images, links, etc. | BaseResponse .prompt | parser/types.ts:169 |
required? | boolean | Controls whether the response is required to be answered. Defaults to true. | BaseResponse .required | parser/types.ts:173 |
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 | parser/types.ts:179 |
requiredValue? | unknown | You can provide a required value, which makes it so a participant has to answer with that value. | BaseResponse .requiredValue | parser/types.ts:177 |
secondaryText? | string | The secondary text that is displayed to the participant under the prompt. This does not accept markdown. | BaseResponse .secondaryText | parser/types.ts:171 |
type | "dropdown" | - | - | parser/types.ts:361 |
withDivider? | boolean | Renders the response with a trailing divider. | BaseResponse .withDivider | parser/types.ts:185 |
withDontKnow? | boolean | Renders the response with an option for "I don't know". This counts as a completed answer for the validation. | BaseResponse .withDontKnow | parser/types.ts:187 |