CheckboxResponse

Defined in: parser/types.ts:449

The CheckboxResponse interface is used to define the properties of a checkbox response. CheckboxResponses render as a checkbox input with user specified options.

{
 "id": "q7",
 "prompt": "Checkbox example (not required)",
 "location": "aboveStimulus",
 "type": "checkbox",
 "options": ["Option 1", "Option 2", "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:185
horizontal?	boolean	Whether to render the checkboxes horizontally. Defaults to false, so they render horizontally.	-	parser/types.ts:458
id	string	The id of the response. This is used to identify the response in the data file.	BaseResponse.id	parser/types.ts:169
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:177
maxSelections?	number	The maximum number of selections that are required.	-	parser/types.ts:456
minSelections?	number	The minimum number of selections that are required.	-	parser/types.ts:454
options	(string | StringOption)[]	The options that are displayed as checkboxes, provided as an array of objects, with label and value fields.	-	parser/types.ts:452
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:183
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:171
required?	boolean	Controls whether the response is required to be answered. Defaults to true.	BaseResponse.required	parser/types.ts:175
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:181
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:179
secondaryText?	string	The secondary text that is displayed to the participant under the prompt. This does not accept markdown.	BaseResponse.secondaryText	parser/types.ts:173
type	"checkbox"	-	-	parser/types.ts:450
withDivider?	boolean	Renders the response with a trailing divider.	BaseResponse.withDivider	parser/types.ts:187
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:189
withOther?	boolean	Whether to render the checkboxes with an "other" option.	-	parser/types.ts:460