neoTour
Create interactive app tours or drive the user's focus across the page.
Based on:
https://shepherdjs.dev/
V 1.0
Guided website sample app (responsive):
https://visualneo.com/tutorials/neotour
Learn spanish body parts sample app (fixed size):
https://visualneo.com/tutorials/neotour2
neoTourInitialize
|
Purpose: |
Initialize neoTour |
|
Category: |
neoTour |
|
Syntax: |
neoTourInitialize "tourName" useOverlay "buttonColor" "buttonTextColor" "headerColor" "titleColor" "mainBgColor" "textColor"
tourName Tour id (ie mytour) useOverlay Use overlay? buttonColor Button color (ie #3288e6) (Optional) buttonTextColor Butten text color (ie: #ffffff) (Optional) headerColor Header background color (ie #e4e4e4) (Optional) titleColor Tite text color (ie #000000) (Optional) mainBgColor Main panel background color (Optional) textColor Text color (ie #000000) (Optional) |
neoTourAddFirstStep
|
Purpose: |
Add a neoTour step with a next button |
|
Category: |
neoTour |
|
Syntax: |
neoTourAddFirstStep "tourName" "objId" "theTitle" theText "nextText" theSub thePosition
tourName Tour id (ie mytour) objId Object to highlight (empty for centered box) theTitle Title theText Text (HTML allowed) nextText Next button text theSub Next button subroutine (optional) thePosition Position |
neoTourAddStep
|
Purpose: |
Add a new neoTour step with back and next buttons |
|
Category: |
neoTour |
|
Syntax: |
neoTourAddStep "tourName" "objId" "theTitle" theText "backText" backSub "nextText" nextSub thePosition
tourName Tour id (ie mytour) objId Object to highlight (empty for centered box) theTitle Title theText Text (HTML allowed) backText Back button text backSub Back button subroutine (optional) nextText Next button text nextSub Next button subroutine (optional) thePosition Position |
neoTourStart
|
Purpose: |
Start neoTour |
|
Category: |
neoTour |
|
Syntax: |
neoTourStart "tourName"
tourName Tour id (ie mytour) |
neoTourBack
|
Purpose: |
Go to the previous neoTour step |
|
Category: |
neoTour |
|
Syntax: |
neoTourBack "tourName"
tourName Tour id (ie mytour) |
neoTourNext
|
Purpose: |
Go to the next neoTour step |
|
Category: |
neoTour |
|
Syntax: |
neoTourNext "tourName"
tourName Tour id (ie mytour) |
neoTourCancel
|
Purpose: |
Cancel the neoTour |
|
Category: |
neoTour |
|
Syntax: |
neoTourCancel "tourName"
tourName Tour id (ie mytour) |
neoTourComplete
|
Purpose: |
Complete the neoTour |
|
Category: |
neoTour |
|
Syntax: |
neoTourComplete "tourName"
tourName Tour id (ie mytour) |
neoTourHide
|
Purpose: |
Hide the current step |
|
Category: |
neoTour |
|
Syntax: |
neoTourHide "tourName"
tourName Tour id (ie mytour) |
neoTourSetEvent
|
Purpose: |
Set a neoTour event |
|
Category: |
neoTour |
|
Syntax: |
neoTourSetEvent "tourName" theEvent theSub
tourName Tour id (ie mytour) theEvent Event theSub Subroutine to execute |
neoTourUnsetEvent
|
Purpose: |
Unset a neoTour event |
|
Category: |
neoTour |
|
Syntax: |
neoTourUnsetEvent "tourName" theEvent
tourName Tour id (ie mytour) theEvent Event |
neoTourShowStep
|
Purpose: |
Show a step by its attached object |
|
Category: |
neoTour |
|
Syntax: |
neoTourShowStep "tourName" "objId"
tourName Tour id (ie mytour) objId Attached object |
neoTourShowStepNumber
|
Purpose: |
Show a step by its number position |
|
Category: |
neoTour |
|
Syntax: |
neoTourShowStepNumber "tourName" theNumber
tourName Tour id (ie mytour) theNumber Step number |
neoTourGetCurrentStep
|
Purpose: |
Returns the currently shown step attached object name |
|
Category: |
neoTour |
|
Syntax: |
neoTourGetCurrentStep "tourName" retVar
tourName Tour id (ie mytour) retVar Variable to store result |