Interface: MarkdownComponent

The MarkdownComponent interface is used to define the properties of a markdown component. The components can be used to render many different things, such as consent forms, instructions, and debriefs. Additionally, you can use the markdown component to render images, videos, and other media, with supporting text.

Hierarchy

Table of contents

Properties

Properties

correctAnswer

Optional 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.

Inherited from

BaseIndividualComponent.correctAnswer

Defined in

parser/types.ts:302


description

Optional description: string

The description of the component. This is used to identify and provide additional information for the component in the admin panel.

Inherited from

BaseIndividualComponent.description

Defined in

parser/types.ts:306


instruction

Optional instruction: string

The instruction of the component. This is used to identify and provide additional information for the component in the admin panel.

Inherited from

BaseIndividualComponent.instruction

Defined in

parser/types.ts:308


instructionLocation

Optional instructionLocation: "sidebar" | "aboveStimulus" | "belowStimulus"

The location of the instructions.

Inherited from

BaseIndividualComponent.instructionLocation

Defined in

parser/types.ts:300


meta

Optional 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.

Inherited from

BaseIndividualComponent.meta

Defined in

parser/types.ts:304


nextButtonLocation

Optional nextButtonLocation: "sidebar" | "aboveStimulus" | "belowStimulus"

The location of the next button.

Inherited from

BaseIndividualComponent.nextButtonLocation

Defined in

parser/types.ts:298


nextButtonText

Optional nextButtonText: string

The text that is displayed on the next button.

Inherited from

BaseIndividualComponent.nextButtonText

Defined in

parser/types.ts:296


path

path: string

The path to the markdown file. This should be a relative path from the public folder.

Defined in

parser/types.ts:317


response

response: Response[]

The responses to the component

Inherited from

BaseIndividualComponent.response

Defined in

parser/types.ts:292


type

type: "markdown"

Defined in

parser/types.ts:315