Skip to main content
Version: v1.0.0

WebsiteComponent

The WebsiteComponent interface is used to define the properties of a website component. A WebsiteComponent is used to render an iframe with a website inside of it. This can be used to display an external website or an html file that is located in the public folder.

{
"type": "website",
"path": "<study-name>/assets/website.html",
}

To pass a data from the config to the website, you can use the parameters field as below:

{
"type": "website",
"path": "<study-name>/website.html",
"parameters": {
"barData": [0.32, 0.01, 1.2, 1.3, 0.82, 0.4, 0.3]
}
"response": [
{
"id": "barChart",
"prompt": "Your selected answer:",
"required": true,
"location": "belowStimulus",
"type": "iframe"
}
],
}

In the website.html file, by including revisit-communicate.js, you can use the Revisit.onDataReceive method to retrieve the data, and Revisit.postAnswers to send the user's responses back to the reVISit as shown in the example below:

<script src="../../revisitUtilities/revisit-communicate.js"></script>
<script>
Revisit.onDataReceive((data) => {
const barData = data['barData'];
...
});

// Call out that 'barChart' needs to match ID in 'response' object
Revisit.postAnswers({ barChart: userAnswer });
</script>
  • If the html website implements Trrack library for provenance tracking, you can send the provenance graph back to reVISit by calling Revisit.postProvenanceGraph as shown in the example below. You need to call this each time the Trrack state is updated so that reVISit is kept aware of the changes in the provenance graph.
const trrack = initializeTrrack({
initialState,
registry
});

...
Revisit.postProvenance(trrack.graph.backend);

Extends

Properties

PropertyTypeDescriptionInherited from
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
description?stringThe description of the component. This is used to identify and provide additional information for the component in the admin panel.BaseIndividualComponent.description
instruction?stringThe instruction of the component. This is used to identify and provide additional information for the component in the admin panel.BaseIndividualComponent.instruction
instructionLocation?"sidebar" | "aboveStimulus" | "belowStimulus"The location of the instructions.BaseIndividualComponent.instructionLocation
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
nextButtonLocation?"sidebar" | "aboveStimulus" | "belowStimulus"The location of the next button.BaseIndividualComponent.nextButtonLocation
nextButtonText?stringThe text that is displayed on the next button.BaseIndividualComponent.nextButtonText
parameters?Record<string, unknown>The parameters that are passed to the website (iframe). These can be used within your website to render different things.-
pathstringThe path to the website. This should be a relative path from the public folder or could be an external website.-
provideFeedback?booleanControls whether the component should provide feedback to the participant, such as in a training trial. If not provided, the default is false.BaseIndividualComponent.provideFeedback
responseResponse[]The responses to the componentBaseIndividualComponent.response
type"website"--