BaseResponse
Defined in: parser/types.ts:482
The BaseResponse interface is used to define the required fields for all responses. Other Response interfaces inherit properties from the BaseResponse interface. Therefore, all responses must include these properties.
Extended by​
NumericalResponseDateResponseTimeResponseShortTextResponseLongTextResponseLikertResponseDropdownResponseSliderResponseRadioResponseCheckboxResponseBaseRankingResponseReactiveResponseCustomResponseButtonsResponse
Properties​
| Property | Type | Description | 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 | parser/types.ts:520 |
excludeFromRandomization? | boolean | Exclude response from randomization. If present, will override the responseOrder randomization setting in the components. Defaults to false. | parser/types.ts:516 |
hidden? | boolean | Controls whether the response is hidden. | parser/types.ts:506 |
id | string | The id of the response. This is used to identify the response in the data file. | parser/types.ts:486 |
infoText? | string | The description that is displayed when the participant hovers over the response. This does not accept markdown. | 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 | parser/types.ts:498 |
onSubmit? | GlobalStoreAction[] | Apply these actions to the final submitted answer, in declared order. | parser/types.ts:484 |
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. | parser/types.ts:504 |
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. | parser/types.ts:488 |
prompt | string | The prompt that is displayed to the participant. You can use markdown here to render images, links, etc. | parser/types.ts:490 |
required? | boolean | Controls whether the response is required to be answered. Defaults to true. | parser/types.ts:496 |
requiredLabel? | string | You can provide a required label, which makes it so a participant has to answer with a response that matches label. | parser/types.ts:502 |
requiredValue? | unknown | You can provide a required value, which makes it so a participant has to answer with that value. | parser/types.ts:500 |
secondaryText? | string | The secondary text that is displayed to the participant under the prompt. This does not accept markdown. | parser/types.ts:492 |
style? | Styles | You can set styles here, using React CSSProperties, for example: {"width": 100} or {"width": "50%"} | parser/types.ts:514 |
stylesheetPath? | string | The path to the external stylesheet file. | parser/types.ts:512 |
visibleIf? | ResponseVisibilityCondition | Show this response only when another response in this component satisfies the condition. | 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. | parser/types.ts:508 |
withDontKnow? | boolean | Renders the response with an option for "I don't know". This counts as a completed answer for the validation. | parser/types.ts:510 |