intro.js
Preparing search index...
packages/tour/option
TourOptions
Interface TourOptions
interface
TourOptions
{
autoPosition
:
boolean
;
buttonClass
:
string
;
disableInteraction
:
boolean
;
doneLabel
:
string
;
dontShowAgain
:
boolean
;
dontShowAgainCookie
:
string
;
dontShowAgainCookieDays
:
number
;
dontShowAgainLabel
:
string
;
exitOnEsc
:
boolean
;
exitOnOverlayClick
:
boolean
;
group
:
string
;
helperElementPadding
:
number
;
hideNext
:
boolean
;
hidePrev
:
boolean
;
highlightClass
:
string
;
isActive
:
boolean
;
keyboardNavigation
:
boolean
;
nextLabel
:
string
;
nextToDone
:
boolean
;
overlayOpacity
:
number
;
positionPrecedence
:
TooltipPosition
[]
;
prevLabel
:
string
;
progressBarAdditionalClass
:
string
;
scrollPadding
:
number
;
scrollTo
:
ScrollTo
;
scrollToElement
:
boolean
;
showBullets
:
boolean
;
showButtons
:
boolean
;
showProgress
:
boolean
;
showStepNumbers
:
boolean
;
skipLabel
:
string
;
stepNumbersOfLabel
:
string
;
steps
:
Partial
<
TourStep
>
[]
;
tooltipClass
:
string
;
tooltipPosition
:
TooltipPosition
;
tooltipRenderAsHtml
?:
boolean
;
}
Index
Properties
auto
Position
button
Class
disable
Interaction
done
Label
dont
Show
Again
dont
Show
Again
Cookie
dont
Show
Again
Cookie
Days
dont
Show
Again
Label
exit
On
Esc
exit
On
Overlay
Click
group
helper
Element
Padding
hide
Next
hide
Prev
highlight
Class
is
Active
keyboard
Navigation
next
Label
next
To
Done
overlay
Opacity
position
Precedence
prev
Label
progress
Bar
Additional
Class
scroll
Padding
scroll
To
scroll
To
Element
show
Bullets
show
Buttons
show
Progress
show
Step
Numbers
skip
Label
step
Numbers
Of
Label
steps
tooltip
Class
tooltip
Position
tooltip
Render
As
Html?
Properties
auto
Position
autoPosition
:
boolean
button
Class
buttonClass
:
string
disable
Interaction
disableInteraction
:
boolean
done
Label
doneLabel
:
string
dont
Show
Again
dontShowAgain
:
boolean
dont
Show
Again
Cookie
dontShowAgainCookie
:
string
dont
Show
Again
Cookie
Days
dontShowAgainCookieDays
:
number
dont
Show
Again
Label
dontShowAgainLabel
:
string
exit
On
Esc
exitOnEsc
:
boolean
exit
On
Overlay
Click
exitOnOverlayClick
:
boolean
group
group
:
string
helper
Element
Padding
helperElementPadding
:
number
hide
Next
hideNext
:
boolean
hide
Prev
hidePrev
:
boolean
highlight
Class
highlightClass
:
string
is
Active
isActive
:
boolean
keyboard
Navigation
keyboardNavigation
:
boolean
next
Label
nextLabel
:
string
next
To
Done
nextToDone
:
boolean
overlay
Opacity
overlayOpacity
:
number
position
Precedence
positionPrecedence
:
TooltipPosition
[]
prev
Label
prevLabel
:
string
progress
Bar
Additional
Class
progressBarAdditionalClass
:
string
scroll
Padding
scrollPadding
:
number
scroll
To
scrollTo
:
ScrollTo
scroll
To
Element
scrollToElement
:
boolean
show
Bullets
showBullets
:
boolean
show
Buttons
showButtons
:
boolean
show
Progress
showProgress
:
boolean
show
Step
Numbers
showStepNumbers
:
boolean
skip
Label
skipLabel
:
string
step
Numbers
Of
Label
stepNumbersOfLabel
:
string
steps
steps
:
Partial
<
TourStep
>
[]
tooltip
Class
tooltipClass
:
string
tooltip
Position
tooltipPosition
:
TooltipPosition
Optional
tooltip
Render
As
Html
tooltipRenderAsHtml
?:
boolean
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
auto
Position
button
Class
disable
Interaction
done
Label
dont
Show
Again
dont
Show
Again
Cookie
dont
Show
Again
Cookie
Days
dont
Show
Again
Label
exit
On
Esc
exit
On
Overlay
Click
group
helper
Element
Padding
hide
Next
hide
Prev
highlight
Class
is
Active
keyboard
Navigation
next
Label
next
To
Done
overlay
Opacity
position
Precedence
prev
Label
progress
Bar
Additional
Class
scroll
Padding
scroll
To
scroll
To
Element
show
Bullets
show
Buttons
show
Progress
show
Step
Numbers
skip
Label
step
Numbers
Of
Label
steps
tooltip
Class
tooltip
Position
tooltip
Render
As
Html
intro.js
Loading...