Skip to main content
Version: v1.0.0

ShortTextResponse

The ShortTextResponse interface is used to define the properties of a short text response. ShortTextResponses render as a text input that accepts any text and can optionally have a placeholder.

{
"id": "q-short-text",
"prompt": "Short text example",
"required": true,
"location": "aboveStimulus",
"type": "shortText",
"placeholder": "Enter your answer here"
}

Extends

Properties

PropertyTypeDescriptionInherited from
hidden?booleanControls whether the response is hidden.BaseResponse.hidden
idstringThe 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 belowStimulusBaseResponse.location
paramCapture?stringUse 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?stringThe placeholder text that is displayed in the input.-
promptstringThe prompt that is displayed to the participant. You can use markdown here to render images, links, etc.BaseResponse.prompt
requiredbooleanControls whether the response is required to be answered.BaseResponse.required
requiredLabel?stringYou can provide a required label, which makes it so a participant has to answer with a response that matches label.BaseResponse.requiredLabel
requiredValue?unknownYou can provide a required value, which makes it so a participant has to answer with that value.BaseResponse.requiredValue
secondaryText?stringThe secondary text that is displayed to the participant under the prompt. This does not accept markdown.BaseResponse.secondaryText
type"shortText"--