SliderResponse

Defined in: parser/types.ts:486

The SliderResponse interface is used to define the properties of a slider response. SliderResponses render as a slider input with user specified steps. For example, you could have steps of 0, 50, and 100.

Example:

{
 "id": "q-slider",
 "prompt": "How are you feeling?",
 "location": "aboveStimulus",
 "type": "slider",
 "options": [
   {
     "label": "Bad",
     "value": 0
   },
   {
     "label": "OK",
     "value": 50
   },
   {
     "label": "Good",
     "value": 100
   }
 ]
}

Extends

• BaseResponse

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
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
options	NumberOption[]	This defines the steps in the slider and the extent of the slider as an array of objects that have a label and a value.	-	parser/types.ts:489
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
smeqStyle?	boolean	Whether to render the slider with a SMEQ style. Defaults to false.	-	parser/types.ts:503
snap?	boolean	Whether the slider should snap between values. Defaults to false. Slider snapping disables the label above the handle.	-	parser/types.ts:493
spacing?	number	The spacing between the ticks. If not provided, the spacing is calculated as the range of the slider divided by power of 10.	-	parser/types.ts:497
startingValue?	number	The starting value of the slider. Defaults to the minimum value.	-	parser/types.ts:491
step?	number	The step value of the slider. If not provided (and snap not enabled), the step value is calculated as the range of the slider divided by 100.	-	parser/types.ts:495
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
tlxStyle?	boolean	Whether to render the slider with a NASA-tlx style. Defaults to false.	-	parser/types.ts:501
type	"slider"	-	-	parser/types.ts:487
withBar?	boolean	Whether to render the slider with a bar to the left. Defaults to true.	-	parser/types.ts:499
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