TextOnlyResponse

Defined in: parser/types.ts:1247

The TextOnlyResponse interface is used to define the properties of a text only response. TextOnlyResponses render as a block of text that is displayed to the user. This can be used to display instructions or other information. It does not accept any input from the user.

{
  "id": "textOnlyResponse",
  "type": "textOnly",
  "prompt": "This is a text only response, it accepts markdown so you can **bold** or _italicize_ text.",
  "location": "belowStimulus",
  "restartEnumeration": true
}

In this example, the text only response is displayed below the stimulus and the enumeration of the questions is restarted.

Extends

Omit<BaseResponse, "secondaryText" | "required" | "requiredValue" | "requiredLabel" | "paramCapture" | "hidden" | "withDontKnow">

Properties

Property	Type	Description	Overrides	Inherited from	Defined in
`delay?`	`number`	Delay in milliseconds before an element activates. Must be non-negative; defaults to 0 meaning the element is always active. Minimum 0	-	`BaseResponse`.`delay`	parser/types.ts:520
`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:516
`hidden?`	`undefined`	-	-	-	parser/types.ts:1259
`id`	`string`	The id of the response. This is used to identify the response in the data file.	-	`BaseResponse`.`id`	parser/types.ts:486
`infoText?`	`string`	The description that is displayed when the participant hovers over the response. This does not accept markdown.	-	`BaseResponse`.`infoText`	parser/types.ts:494
`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:498
`onSubmit?`	`GlobalStoreAction`[]	Apply these actions to the final submitted answer, in declared order.	-	`BaseResponse`.`onSubmit`	parser/types.ts:484
`paramCapture?`	`undefined`	-	-	-	parser/types.ts:1258
`path?`	`string`	Path under `src/public/` to response code. Custom responses require a default React component. Any response code module may export `validate(value, values, response)` to return an error message, a boolean validity result, or null for valid input. It may separately export `score(value, values, response, expected?)` to return a boolean or a score from 0 to 1; null uses ordinary correct-answer matching. `expected` is the configured correct answer when correctness is checked.	-	`BaseResponse`.`path`	parser/types.ts:488
`prompt`	`string`	The markdown text that is displayed to the user.	`BaseResponse`.`prompt`	-	parser/types.ts:1250
`required?`	`undefined`	-	-	-	parser/types.ts:1255
`requiredLabel?`	`undefined`	-	-	-	parser/types.ts:1257
`requiredValue?`	`undefined`	-	-	-	parser/types.ts:1256
`restartEnumeration?`	`boolean`	Whether to restart the enumeration of the questions. Defaults to false.	-	-	parser/types.ts:1252
`secondaryText?`	`undefined`	-	-	-	parser/types.ts:1254
`style?`	`Styles`	You can set styles here, using React CSSProperties, for example: `{"width": 100}` or `{"width": "50%"}`	-	`BaseResponse`.`style`	parser/types.ts:514
`stylesheetPath?`	`string`	The path to the external stylesheet file.	-	`BaseResponse`.`stylesheetPath`	parser/types.ts:512
`type`	`"textOnly"`	-	-	-	parser/types.ts:1248
`visibleIf?`	`ResponseVisibilityCondition`	Show this response only when another response in this component satisfies the condition.	-	`BaseResponse`.`visibleIf`	parser/types.ts:518
`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:508
`withDontKnow?`	`undefined`	-	-	-	parser/types.ts:1260

Extends​

Properties​

Extends

Properties