NumericalResponse

Defined in: parser/types.ts:207

The NumericalResponse interface is used to define the properties of a numerical response. NumericalResponses render as a text input that only accepts numbers, and can optionally have a min and max value, or a placeholder.

Example:

{
 "id": "q-numerical",
 "prompt": "Numerical example",
 "location": "aboveStimulus",
 "type": "numerical",
 "placeholder": "Enter your age, range from 0 - 120",
 "max": 120,
 "min": 0
}

Extends

• BaseResponse

Properties

Property	Type	Description	Inherited from	Defined in
hidden?	boolean	Controls whether the response is hidden.	BaseResponse.hidden	parser/types.ts:183
id	string	The id of the response. This is used to identify the response in the data file.	BaseResponse.id	parser/types.ts:167
location?	"sidebar" | "aboveStimulus" | "belowStimulus"	Controls the response location. These might be the same for all responses, or differ across responses. Defaults to belowStimulus	BaseResponse.location	parser/types.ts:175
max?	number	The maximum value that is accepted in the input.	-	parser/types.ts:214
min?	number	The minimum value that is accepted in the input.	-	parser/types.ts:212
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:181
placeholder?	string	The placeholder text that is displayed in the input.	-	parser/types.ts:210
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:169
required?	boolean	Controls whether the response is required to be answered. Defaults to true.	BaseResponse.required	parser/types.ts:173
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:179
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:177
secondaryText?	string	The secondary text that is displayed to the participant under the prompt. This does not accept markdown.	BaseResponse.secondaryText	parser/types.ts:171
type	"numerical"	-	-	parser/types.ts:208
withDivider?	boolean	Renders the response with a trailing divider.	BaseResponse.withDivider	parser/types.ts:185
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:187