ReactComponent

Defined in: parser/types.ts:623

The ReactComponent interface is used to define the properties of a react component. This component is used to render react code with certain parameters. These parameters can be used within your react code to render different things.

Unlike other types of components, the path for a React component is relative to the src/public/ folder. Similar to our standard assets, we suggest creating a folder named src/public/{studyName}/assets to house all of the React component assets for a particular study. Your React component which you link to in the path must be default exported from its file.

React components created this way have a generic prop type passed to the component on render, <StimulusParams<T>>, which has the following types.

{
 parameters: T;
 setAnswer: ({ status, provenanceGraph, answers }: { status: boolean, provenanceGraph?: TrrackedProvenance, answers: Record<string, any> }) => void
}

parameters is the same object passed in from the ReactComponent type below, allowing you to pass options in from the config to your component. setAnswer is a callback function allowing the creator of the ReactComponent to programmatically set the answer, as well as the provenance graph. This can be useful if you don't use the default answer interface, and instead have something more unique.

So, for example, if I had the following ReactComponent in my config

{
 type: 'react-component';
 path: 'my_study/CoolComponent.tsx';
 parameters: {
   name: 'Zach';
   age: 26;
 }
}

My react component, CoolComponent.tsx, would exist in src/public/my_study/assets, and look something like this

export default function CoolComponent({ parameters, setAnswer }: StimulusParams<{name: string, age: number}>) {
 // render something
}

For in depth examples, see the following studies, and their associated codebases. https://revisit.dev/study/demo-click-accuracy-test (https://github.com/revisit-studies/study/tree/v2.0.0-rc6/src/public/demo-click-accuracy-test/assets) https://revisit.dev/study/example-brush-interactions (https://github.com/revisit-studies/study/tree/v2.0.0-rc6/src/public/example-brush-interactions/assets)

Extends

• BaseIndividualComponent

Properties

Property	Type	Description	Inherited from	Defined in
allowFailedTraining?	boolean	Controls whether the component should allow failed training. If not provided, the default is true.	BaseIndividualComponent.allowFailedTraining	parser/types.ts:546
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.	BaseIndividualComponent.correctAnswer	parser/types.ts:540
description?	string	The description of the component. This is used to identify and provide additional information for the component in the admin panel.	BaseIndividualComponent.description	parser/types.ts:550
instruction?	string	The instruction of the component. This is used to identify and provide additional information for the component in the admin panel.	BaseIndividualComponent.instruction	parser/types.ts:552
instructionLocation?	"sidebar" | "aboveStimulus" | "belowStimulus"	The location of the instructions.	BaseIndividualComponent.instructionLocation	parser/types.ts:538
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.	BaseIndividualComponent.meta	parser/types.ts:548
nextButtonDisableTime?	number	A timeout (in ms) after which the next button will be disabled.	BaseIndividualComponent.nextButtonDisableTime	parser/types.ts:556
nextButtonEnableTime?	number	A timer (in ms) after which the next button will be enabled.	BaseIndividualComponent.nextButtonEnableTime	parser/types.ts:558
nextButtonLocation?	"sidebar" | "aboveStimulus" | "belowStimulus"	The location of the next button.	BaseIndividualComponent.nextButtonLocation	parser/types.ts:536
nextButtonText?	string	The text that is displayed on the next button.	BaseIndividualComponent.nextButtonText	parser/types.ts:534
parameters?	Record<string, unknown>	The parameters that are passed to the react component. These can be used within your react component to render different things.	-	parser/types.ts:628
path	string	The path to the react component. This should be a relative path from the src/public folder.	-	parser/types.ts:626
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.	BaseIndividualComponent.provideFeedback	parser/types.ts:542
recordAudio?	boolean	Whether or not to record audio for a component. Only relevant if StudyConfig.recordStudyAudio is true. Defaults to true.	BaseIndividualComponent.recordAudio	parser/types.ts:554
response	Response[]	The responses to the component	BaseIndividualComponent.response	parser/types.ts:530
responseDividers?	boolean	Whether to show the response dividers. Defaults to false.	BaseIndividualComponent.responseDividers	parser/types.ts:560
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.	BaseIndividualComponent.trainingAttempts	parser/types.ts:544
type	"react-component"	-	-	parser/types.ts:624