NumericalResponse

Defined in: parser/types.ts:396

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.

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

Extends

• BaseResponse

Properties

Property	Type	Description	Inherited from	Defined in
default?	number	The default value of the response. Specify a numeric value such as 25 or 3.14.	-	parser/types.ts:401
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
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
max?	number	The maximum value that is accepted in the input.	-	parser/types.ts:405
min?	number	The minimum value that is accepted in the input.	-	parser/types.ts:403
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
placeholder?	string	The placeholder text that is displayed in the input.	-	parser/types.ts:399
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
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
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	"numerical"	-	-	parser/types.ts:397
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