NumericalResponse
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
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
hidden? | boolean | Controls whether the response is hidden. | BaseResponse.hidden |
id | string | The id of the response. This is used to identify the response in the data file. | BaseResponse.id |
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 |
max? | number | The maximum value that is accepted in the input. | - |
min? | number | The minimum value that is accepted in the input. | - |
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 |
placeholder? | string | The placeholder text that is displayed in the input. | - |
prompt | string | The prompt that is displayed to the participant. You can use markdown here to render images, links, etc. | BaseResponse.prompt |
required? | boolean | Controls whether the response is required to be answered. Defaults to true. | BaseResponse.required |
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 |
requiredValue? | unknown | You can provide a required value, which makes it so a participant has to answer with that value. | BaseResponse.requiredValue |
secondaryText? | string | The secondary text that is displayed to the participant under the prompt. This does not accept markdown. | BaseResponse.secondaryText |
type | "numerical" | - | - |