MatrixCheckboxResponse

Defined in: parser/types.ts:891

The MatrixCheckboxResponse interface defines a matrix where each row can select multiple options. questionOptions are rendered as rows, and answerOptions are rendered as columns. Defaults are specified per-row as arrays of selected answer option values.

Example using custom columns (answerOptions):

{
  "id": "multi-custom",
  "prompt": "Which categories do the following items belong to?",
  "location": "aboveStimulus",
  "type": "matrix-checkbox",
  "answerOptions": [
    "Has Legs",
    "Has Wings",
    "Can Swim"
  ],
  "questionOptions": [
    "Dog",
    "Snake",
    "Eagle",
    "Salmon",
    "Platypus"
  ],
  "default": {
    "Dog": ["Has Legs"],
    "Snake": [],
    "Eagle": ["Has Wings"],
    "Salmon": ["Can Swim"],
    "Platypus": ["Has Legs", "Can Swim"]
  }
}

Extends

• BaseMatrixResponse

Properties

Property	Type	Description	Inherited from	Defined in
answerOptions	(string | StringOption)[] | "likely5" | "likely7" | "satisfaction5" | "satisfaction7"	The answer options (columns). We provide some shortcuts for a likelihood scale (ranging from highly unlikely to highly likely) and a satisfaction scale (ranging from highly unsatisfied to highly satisfied) with either 5 or 7 options to choose from.	BaseMatrixResponse.answerOptions	parser/types.ts:812
default?	Record<string, string[]>	The default value of the response by question key. Provide an object where each key is a question value and each value is an array of selected answer option values.	-	parser/types.ts:894
delay?	number	Delay in milliseconds before an element activates. Must be non-negative; defaults to 0 meaning the element is always active. Minimum 0	BaseMatrixResponse.delay	parser/types.ts:520
excludeFromRandomization?	boolean	Exclude response from randomization. If present, will override the responseOrder randomization setting in the components. Defaults to false.	BaseMatrixResponse.excludeFromRandomization	parser/types.ts:516
hidden?	boolean	Controls whether the response is hidden.	BaseMatrixResponse.hidden	parser/types.ts:506
id	string	The id of the response. This is used to identify the response in the data file.	BaseMatrixResponse.id	parser/types.ts:486
infoText?	string	The description that is displayed when the participant hovers over the response. This does not accept markdown.	BaseMatrixResponse.infoText	parser/types.ts:494
location?	ConfigResponseBlockLocation	Controls the response location. These might be the same for all responses, or differ across responses. Defaults to belowStimulus	BaseMatrixResponse.location	parser/types.ts:498
max?	number	The maximum amount of answers given per row for the matrix.	-	parser/types.ts:898
min?	number	The minimum amount of answers given per row for the matrix.	-	parser/types.ts:896
onSubmit?	GlobalStoreAction[]	Apply these actions to the final submitted answer, in declared order.	BaseMatrixResponse.onSubmit	parser/types.ts:484
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.	BaseMatrixResponse.paramCapture	parser/types.ts:504
path?	string	Path under src/public/ to response code. Custom responses require a default React component. Any response code module may export validate(value, values, response) to return an error message, a boolean validity result, or null for valid input. It may separately export score(value, values, response, expected?) to return a boolean or a score from 0 to 1; null uses ordinary correct-answer matching. expected is the configured correct answer when correctness is checked.	BaseMatrixResponse.path	parser/types.ts:488
prompt	string	The prompt that is displayed to the participant. You can use markdown here to render images, links, etc.	BaseMatrixResponse.prompt	parser/types.ts:490
questionOptions	(string | MatrixQuestionOption)[]	The question options (rows) are the prompts for each response you'd like to record. Use leftLabel and rightLabel on object options to display bipolar row labels such as "Obstructive - Supportive" on either side of the matrix.	BaseMatrixResponse.questionOptions	parser/types.ts:814
questionOrder?	"fixed" | "random"	The order in which the questions are displayed. Defaults to fixed.	BaseMatrixResponse.questionOrder	parser/types.ts:816
required?	boolean	Controls whether the response is required to be answered. Defaults to true.	BaseMatrixResponse.required	parser/types.ts:496
requiredLabel?	string	You can provide a required label, which makes it so a participant has to answer with a response that matches label.	BaseMatrixResponse.requiredLabel	parser/types.ts:502
requiredValue?	unknown	You can provide a required value, which makes it so a participant has to answer with that value.	BaseMatrixResponse.requiredValue	parser/types.ts:500
secondaryText?	string	The secondary text that is displayed to the participant under the prompt. This does not accept markdown.	BaseMatrixResponse.secondaryText	parser/types.ts:492
style?	Styles	You can set styles here, using React CSSProperties, for example: {"width": 100} or {"width": "50%"}	BaseMatrixResponse.style	parser/types.ts:514
stylesheetPath?	string	The path to the external stylesheet file.	BaseMatrixResponse.stylesheetPath	parser/types.ts:512
type	"matrix-checkbox"	-	-	parser/types.ts:892
visibleIf?	ResponseVisibilityCondition	Show this response only when another response in this component satisfies the condition.	BaseMatrixResponse.visibleIf	parser/types.ts:518
withDivider?	boolean	Renders the response with a trailing divider. If present, will override the divider setting in the components or uiConfig.	BaseMatrixResponse.withDivider	parser/types.ts:508
withDontKnow?	boolean	Renders the response with an option for "I don't know". This counts as a completed answer for the validation.	BaseMatrixResponse.withDontKnow	parser/types.ts:510