LikertResponse
Defined in: parser/types.ts:361
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",
"numItems": 5,
"start": 1,
"spacing": 1
}
Extends
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
hidden? | boolean | Controls whether the response is hidden. | BaseResponse.hidden | parser/types.ts:260 |
id | string | The id of the response. This is used to identify the response in the data file. | BaseResponse.id | parser/types.ts:244 |
leftLabel? | string | The left label of the likert scale. E.g Strongly Disagree | - | parser/types.ts:370 |
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 |
numItems | number | The number of options to render. | - | parser/types.ts:364 |
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 |
rightLabel? | string | The right label of the likert scale. E.g Strongly Agree | - | parser/types.ts:372 |
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 |
spacing? | number | The spacing between the options. Defaults to 1. | - | parser/types.ts:368 |
start? | number | The starting value of the likert scale. Defaults to 1. | - | parser/types.ts:366 |
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 | "likert" | - | - | parser/types.ts:362 |
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 |