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[]

Inherited from

BaseIndividualComponent.correctAnswer

Defined in

types.ts:206


description

Optional description: string

Inherited from

BaseIndividualComponent.description

Defined in

types.ts:208


instruction

Optional instruction: string

Inherited from

BaseIndividualComponent.instruction

Defined in

types.ts:209


instructionLocation

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

Inherited from

BaseIndividualComponent.instructionLocation

Defined in

types.ts:205


meta

Optional meta: Record<string, unknown>

Inherited from

BaseIndividualComponent.meta

Defined in

types.ts:207


nextButtonLocation

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

Inherited from

BaseIndividualComponent.nextButtonLocation

Defined in

types.ts:204


nextButtonText

Optional nextButtonText: string

Inherited from

BaseIndividualComponent.nextButtonText

Defined in

types.ts:203


path

path: string

Defined in

types.ts:218


response

response: Response[]

Inherited from

BaseIndividualComponent.response

Defined in

types.ts:200


title

Optional title: string

Inherited from

BaseIndividualComponent.title

Defined in

types.ts:210


type

type: "markdown"

Defined in

types.ts:217