Skip to main content
Version: v2.2.0

BaseResponse

Defined in: parser/types.ts:242

The BaseResponse interface is used to define the required fields for all responses. Other Response interfaces inherit properties from the BaseResponse interface. Therefore, all responses must include these properties.

Extended by

Properties

PropertyTypeDescriptionDefined in
hidden?booleanControls whether the response is hidden.parser/types.ts:260
idstringThe id of the response. This is used to identify the response in the data file.parser/types.ts:244
location?ConfigResponseBlockLocationControls the response location. These might be the same for all responses, or differ across responses. Defaults to belowStimulusparser/types.ts:252
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.parser/types.ts:258
promptstringThe prompt that is displayed to the participant. You can use markdown here to render images, links, etc.parser/types.ts:246
required?booleanControls whether the response is required to be answered. Defaults to true.parser/types.ts:250
requiredLabel?stringYou can provide a required label, which makes it so a participant has to answer with a response that matches label.parser/types.ts:256
requiredValue?unknownYou can provide a required value, which makes it so a participant has to answer with that value.parser/types.ts:254
secondaryText?stringThe secondary text that is displayed to the participant under the prompt. This does not accept markdown.parser/types.ts:248
style?StylesYou can set styles here, using React CSSProperties, for example: {"width": 100} or {"width": "50%"}parser/types.ts:268
stylesheetPath?stringThe path to the external stylesheet file.parser/types.ts:266
withDivider?booleanRenders the response with a trailing divider. If present, will override the divider setting in the components or uiConfig.parser/types.ts:262
withDontKnow?booleanRenders the response with an option for "I don't know". This counts as a completed answer for the validation.parser/types.ts:264