Instruction Components
Check out the components that you can use inside the markdown of instructions
Last updated
Check out the components that you can use inside the markdown of instructions
Last updated
Simple link to a URL:
to
string
required
URL to link to
color
string
optional
Custom text color
Choose between different variants or customize it with your own colors:
to
string
required
URL to link to
variant
enum
optional
Pick a style: white
, danger
, warning
, success
or outline
background
string
optional
Custom background color
color
string
optional
Custom text color
Place a link that takes the user to a specific tab inside the lab:
id
string
required
Resource id of the target tab
color
string
optional
Custom text color
Place a button that takes the user to a specific tab inside the lab:
id
string
required
Resource id of the target tab
variant
enum
optional
Pick a style: white
, danger
, warning
, success
or outline
background
string
optional
Custom background color
color
string
optional
Custom text color
Show a code snippet to the user:
language
string
optional
Which syntax highlight to use
line-numbers
boolean
optional
Show each line number
line-numbers-start
number
optional
What number to start counting from
no-copy
boolean
optional
Hide the copy button
run
boolean
optional
Offer to run the code in a terminal
title
string
optional
Used only by the code group component
Group code snippets together:
Show how the user is progressing on their tasks, with a call to action when they are all complete:
heading
string
optional
Greetings message
finish-button-label
string
optional
Call to action button text
Ask the user to rate the track with an optional message:
Show the user an embedded PDF:
url
string
required
URL to the file
Interactively ask questions to the user:
id
string
required
Resource id of the quiz
Embed a presentation from Google Slides:
id
string
required
Google Slides id
Show the user a breakdown of task conditions:
id
string
required
Resource id of the task
Embed a video from Vimeo or YouTube:
id
string
required
The id of the video
source
enum
optional
Either vimeo
or youtube
, defaults to youtube