LikertResponse

Defined in: parser/types.ts:477

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).",
  "location": "aboveStimulus",
  "type": "likert",
  "leftLabel": "Not Enjoyable",
  "rightLabel": "Very Enjoyable",
  "labelLocation": "inline",
  "numItems": 5,
  "default": 4,
  "start": 1,
  "spacing": 1
}

Extends

• BaseResponse

Properties

Property	Type	Description	Inherited from	Defined in
default?	string | number	The default value of the response. Specify a rendered option value as a number or string (for example 4 or "4").	-	parser/types.ts:482
excludeFromRandomization?	boolean	Exclude response from randomization. If present, will override the responseOrder randomization setting in the components. Defaults to false.	BaseResponse.excludeFromRandomization	parser/types.ts:377
hidden?	boolean	Controls whether the response is hidden.	BaseResponse.hidden	parser/types.ts:367
id	string	The id of the response. This is used to identify the response in the data file.	BaseResponse.id	parser/types.ts:349
infoText?	string	The description that is displayed when the participant hovers over the response. This does not accept markdown.	BaseResponse.infoText	parser/types.ts:355
labelLocation?	"above" | "inline" | "below"	The location of the labels. Defaults to inline.	-	parser/types.ts:492
leftLabel?	string	The left label of the likert scale. E.g Strongly Disagree	-	parser/types.ts:488
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:359
numItems	number	The number of options to render.	-	parser/types.ts:480
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:365
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:351
required?	boolean	Controls whether the response is required to be answered. Defaults to true.	BaseResponse.required	parser/types.ts:357
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:363
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:361
rightLabel?	string	The right label of the likert scale. E.g Strongly Agree	-	parser/types.ts:490
secondaryText?	string	The secondary text that is displayed to the participant under the prompt. This does not accept markdown.	BaseResponse.secondaryText	parser/types.ts:353
spacing?	number	The spacing between the options. Defaults to 1.	-	parser/types.ts:486
start?	number	The starting value of the likert scale. Defaults to 1.	-	parser/types.ts:484
style?	Styles	You can set styles here, using React CSSProperties, for example: {"width": 100} or {"width": "50%"}	BaseResponse.style	parser/types.ts:375
stylesheetPath?	string	The path to the external stylesheet file.	BaseResponse.stylesheetPath	parser/types.ts:373
type	"likert"	-	-	parser/types.ts:478
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:369
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:371