Skip to main content

Tutorial

Props

AttributeDescriptionTypeDefault
startStart Tutorial component.booleanfalse
stepsDefine steps of Tutorial component, steps prop takes two parameters text and compID. Text parameter specifies the description of the step, compID specifies the component we want to include in highlight.arrayundefined
nextButtonLabelNext button label.stringNext
skipButtonLabelSkip button label.stringSkip
prevButtonLabelPrevious button label.stringBack
doneButtonLabelDone button label.stringDone
hidePrevButtonHide the previous button in the first step? Otherwise, it will render a disabled button.booleanfalse
showstepNumbersShow steps number in the red circle or not, true or false.booleanfalse
keyboardNavigationNavigating with keyboard or not, true or false.booleanfalse
visibleVisibility of Tutorial component.booleantrue

Events

AttributeDescription
beforeExitTrigger when you exit the Tutorial component or when you press the skip button
onafterchangeTrigger when you chane step of the Tutorial component
oncompleteTrigger when you complete Tutorial component

Methods

AttributeDescription
startStart Tutorial component
goToStepStart Tutorial component from step that you define. (Exp: goToStep(2))

Tutorial Data Values

AttributeDescription
currentStepValueGet currentStep value of the component

Samples Qjson

QTutorialFinalDemo