Skip to main content

IPrologue interface

📖 Description​

Interface that describes the properties to define a form prologue within a form definition. A prologue can be used by runners (that support it) to show a welcome message before starting the actual form.

📃 Type declaration​

interface IPrologue {
  title?: string;ReadonlyOptional
  description?: string;ReadonlyOptional
  image?: string;ReadonlyOptional
  video?: string;ReadonlyOptional
  button?: string;ReadonlyOptional
}
🖱ī¸ Hover with the mouse over a property name for a tooltip with the description of that property. Click it for more information.

🗃ī¸ Properties​

🏷ī¸ button​

Specifies the label of the button that starts the form.

Type​

string

🏷ī¸ description​

Specifies the description (supports markdown).

Type​

string

🏷ī¸ image​

Specifies the URL of an image to show.

Type​

string

tip

It is possible to embed images using Base64 encoding.

🏷ī¸ title​

Specifies the title (supports markdown).

Type​

string

🏷ī¸ video​

Specifies the URL of a video to show. Currently, YouTube and Vimeo are supported. The shareable URL of the video needs to be supplied.

Type​

string