BaseIndividualComponent
Defined in: parser/types.ts:557
The BaseIndividualComponent interface is used to define the required fields for all components.
All components must include the response field, which is an array of Response interfaces. There are additional optional fields that can be included in a component that help layout the task. These include the nextButtonText, nextButtonLocation, instructionLocation, correctAnswer. There are other fields that can be included in a component that are used to identify the task in the admin panel. These include the meta, description, instruction, and title fields.
Extended by
MarkdownComponentReactComponentImageComponentWebsiteComponentQuestionnaireComponentVegaComponentPathVegaComponentConfigVideoComponent
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
allowFailedTraining? | boolean | Controls whether the component should allow failed training. If not provided, the default is true. | parser/types.ts:576 |
correctAnswer? | Answer[] | The correct answer to the component. This is used for training trials where the user is shown the correct answer after a guess. | parser/types.ts:570 |
description? | string | The description of the component. This is used to identify and provide additional information for the component in the admin panel. | parser/types.ts:580 |
helpTextPathOverride? | string | Optional override for the help text. If present, will override the default help text path set in the uiConfig. | parser/types.ts:592 |
instruction? | string | The instruction of the component. This is used to identify and provide additional information for the component in the admin panel. | parser/types.ts:582 |
instructionLocation? | ConfigResponseBlockLocation | The location of the instructions. | parser/types.ts:568 |
meta? | Record<string, unknown> | The meta data for the component. This is used to identify and provide additional information for the component in the admin panel. | parser/types.ts:578 |
nextButtonDisableTime? | number | A timeout (in ms) after which the next button will be disabled. | parser/types.ts:586 |
nextButtonEnableTime? | number | A timer (in ms) after which the next button will be enabled. | parser/types.ts:588 |
nextButtonLocation? | ConfigResponseBlockLocation | The location of the next button. | parser/types.ts:566 |
nextButtonText? | string | The text that is displayed on the next button. | parser/types.ts:564 |
provideFeedback? | boolean | Controls whether the component should provide feedback to the participant, such as in a training trial. If not provided, the default is false. | parser/types.ts:572 |
recordAudio? | boolean | Whether or not to record audio for a component. Only relevant if recordStudyAudio in the uiConfig is true. Defaults to false. | parser/types.ts:584 |
response | Response[] | The responses to the component | parser/types.ts:560 |
responseDividers? | boolean | Whether to show the response dividers. Defaults to false. | parser/types.ts:590 |
trainingAttempts? | number | The number of training attempts allowed for the component. The next button will be disabled until either the correct answer is given or the number of attempts is reached. When the number of attempts is reached, if the answer is incorrect still, the correct value will be shown to the participant. The default value is 2. Providing a value of -1 will allow infinite attempts and the participant must enter the correct answer to continue, and reVISit will not show the correct answer to the user. | parser/types.ts:574 |