CheckboxResponse
Defined in: parser/types.ts:552
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
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
hidden? | boolean | Controls whether the response is hidden. | BaseResponse.hidden | parser/types.ts:260 |
horizontal? | boolean | Whether to render the checkboxes horizontally. Defaults to false, so they render horizontally. | - | parser/types.ts:563 |
id | string | The id of the response. This is used to identify the response in the data file. | BaseResponse.id | parser/types.ts:244 |
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:252 |
maxSelections? | number | The maximum number of selections that are required. | - | parser/types.ts:561 |
minSelections? | number | The minimum number of selections that are required. | - | parser/types.ts:559 |
optionOrder? | "fixed" | "random" | The order in which the checkboxes are displayed. Defaults to fixed. | - | parser/types.ts:557 |
options | (string | StringOption)[] | The options that are displayed as checkboxes, provided as an array of objects, with label and value fields. | - | parser/types.ts:555 |
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:258 |
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:246 |
required? | boolean | Controls whether the response is required to be answered. Defaults to true. | BaseResponse.required | parser/types.ts:250 |
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:256 |
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:254 |
secondaryText? | string | The secondary text that is displayed to the participant under the prompt. This does not accept markdown. | BaseResponse.secondaryText | parser/types.ts:248 |
style? | Styles | You can set styles here, using React CSSProperties, for example: {"width": 100} or {"width": "50%"} | BaseResponse.style | parser/types.ts:268 |
stylesheetPath? | string | The path to the external stylesheet file. | BaseResponse.stylesheetPath | parser/types.ts:266 |
type | "checkbox" | - | - | parser/types.ts:553 |
withDivider? | boolean | Renders the response with a trailing divider. If present, will override the divider setting in the components or uiConfig. | BaseResponse.withDivider | parser/types.ts:262 |
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:264 |
withOther? | boolean | Whether to render the checkboxes with an "other" option. | - | parser/types.ts:565 |