IFrameResponse

The IFrameResponse interface is used to define the properties of an iframe response. IFrameResponses render as a list, that is connected to a WebsiteComponent. When data is sent from the WebsiteComponent, it is displayed in the list.

Extends

• BaseResponse

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
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
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.	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	"iframe"	-	-