Skip to main content
Version: v1.0.4

LikertResponse

The LikertResponse interface is used to define the properties of a likert response. LikertResponses render as radio buttons with a user specified number of options, which can be controlled through the numItems. For example, numItems: 5 will render 5 radio buttons, and numItems: 7 will render 7 radio buttons. LikertResponses can also have a description, and left and right labels. The left and right labels are used to label the left and right ends of the likert scale with values such as 'Strongly Disagree' and 'Strongly Agree'.

Example for a five-point Likert Scale:

{
"id": "q-satisfaction",
"prompt": "Rate your satisfaction from 1 (not enjoyable) to 5 (very enjoyable).",
"required": true,
"location": "aboveStimulus",
"type": "likert",
"leftLabel": "Not Enjoyable",
"rightLabel": "Very Enjoyable",
"numItems": 5
}

Extends

Properties

PropertyTypeDescriptionInherited from
desc?stringThe description of the likert scale.-
hidden?booleanControls whether the response is hidden.BaseResponse.hidden
idstringThe id of the response. This is used to identify the response in the data file.BaseResponse.id
leftLabel?stringThe left label of the likert scale. E.g Strongly Disagree-
location?"sidebar" | "aboveStimulus" | "belowStimulus"Controls the response location. These might be the same for all responses, or differ across responses. Defaults to belowStimulusBaseResponse.location
numItemsnumberThe number of options to render.-
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.paramCapture
promptstringThe prompt that is displayed to the participant. You can use markdown here to render images, links, etc.BaseResponse.prompt
requiredbooleanControls whether the response is required to be answered.BaseResponse.required
requiredLabel?stringYou can provide a required label, which makes it so a participant has to answer with a response that matches label.BaseResponse.requiredLabel
requiredValue?unknownYou can provide a required value, which makes it so a participant has to answer with that value.BaseResponse.requiredValue
rightLabel?stringThe right label of the likert scale. E.g Strongly Agree-
secondaryText?stringThe secondary text that is displayed to the participant under the prompt. This does not accept markdown.BaseResponse.secondaryText
type"likert"--