Skip to main content
Version: v2.2.0

RadioResponse

Defined in: parser/types.ts:522

The RadioResponse interface is used to define the properties of a radio response. Radios have only one allowable selection. RadioResponses render as a radio input with user specified options, and optionally left and right labels.

Example:

{
"id": "q-radio",
"prompt": "Radio button example",
"location": "aboveStimulus",
"type": "radio",
"options": ["Option 1", "Option 2"]
}

Extends

Properties

PropertyTypeDescriptionInherited fromDefined in
hidden?booleanControls whether the response is hidden.BaseResponse.hiddenparser/types.ts:260
horizontal?booleanWhether to render the radio buttons horizontally. Defaults to false, so they render horizontally.-parser/types.ts:533
idstringThe id of the response. This is used to identify the response in the data file.BaseResponse.idparser/types.ts:244
leftLabel?stringThe left label of the radio group. Used in Likert scales for example-parser/types.ts:529
location?ConfigResponseBlockLocationControls the response location. These might be the same for all responses, or differ across responses. Defaults to belowStimulusBaseResponse.locationparser/types.ts:252
optionOrder?"fixed" | "random"The order in which the radio buttons are displayed. Defaults to fixed.-parser/types.ts:527
options(string | StringOption)[]The options that are displayed as checkboxes, provided as an array of objects, with label and value fields.-parser/types.ts:525
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.BaseResponse.paramCaptureparser/types.ts:258
promptstringThe prompt that is displayed to the participant. You can use markdown here to render images, links, etc.BaseResponse.promptparser/types.ts:246
required?booleanControls whether the response is required to be answered. Defaults to true.BaseResponse.requiredparser/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.BaseResponse.requiredLabelparser/types.ts:256
requiredValue?unknownYou can provide a required value, which makes it so a participant has to answer with that value.BaseResponse.requiredValueparser/types.ts:254
rightLabel?stringThe right label of the radio group. Used in Likert scales for example-parser/types.ts:531
secondaryText?stringThe secondary text that is displayed to the participant under the prompt. This does not accept markdown.BaseResponse.secondaryTextparser/types.ts:248
style?StylesYou can set styles here, using React CSSProperties, for example: {"width": 100} or {"width": "50%"}BaseResponse.styleparser/types.ts:268
stylesheetPath?stringThe path to the external stylesheet file.BaseResponse.stylesheetPathparser/types.ts:266
type"radio"--parser/types.ts:523
withDivider?booleanRenders the response with a trailing divider. If present, will override the divider setting in the components or uiConfig.BaseResponse.withDividerparser/types.ts:262
withDontKnow?booleanRenders the response with an option for "I don't know". This counts as a completed answer for the validation.BaseResponse.withDontKnowparser/types.ts:264
withOther?booleanWhether to render the radios with an "other" option.-parser/types.ts:535