ButtonsResponse

Defined in: parser/types.ts:503

The ButtonsResponse interface is used to define the properties of a buttons response. ButtonsResponses render as a list of buttons that the participant can click. When a button is clicked, the value of the button is stored in the data file. Participants can cycle through the options using the arrow keys.

Example:

{
  "id": "buttonsResponse",
  "type": "buttons",
  "prompt": "Click a button",
  "location": "belowStimulus",
  "options": [
    "Option 1",
    "Option 2",
    "Option 3"
  ]
}

In this example, the participant can click one of the buttons labeled "Option 1", "Option 2", or "Option 3".

Extends

• BaseResponse

Properties

Property	Type	Description	Inherited from	Defined in
hidden?	boolean	Controls whether the response is hidden.	BaseResponse.hidden	parser/types.ts:177
id	string	The id of the response. This is used to identify the response in the data file.	BaseResponse.id	parser/types.ts:161
location?	ConfigResponseBlockLocation	Controls the response location. These might be the same for all responses, or differ across responses. Defaults to belowStimulus	BaseResponse.location	parser/types.ts:169
options	(string | StringOption)[]	-	-	parser/types.ts:505
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:175
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:163
required?	boolean	Controls whether the response is required to be answered. Defaults to true.	BaseResponse.required	parser/types.ts:167
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:173
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:171
secondaryText?	string	The secondary text that is displayed to the participant under the prompt. This does not accept markdown.	BaseResponse.secondaryText	parser/types.ts:165
type	"buttons"	-	-	parser/types.ts:504
withDivider?	boolean	Renders the response with a trailing divider.	BaseResponse.withDivider	parser/types.ts:179
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:181