Interface JoyrideOptions

public autoStart: boolean

true or false - false tour starts when restart called

member

{boolean}

public cookieDomain: any

Will this cookie be attached to a domain, ie. '.notableapp.com'

member

{any}

public cookieMonster: boolean

true/false for whether cookies are used

member

{boolean}

public cookieName: string

choose your own cookie name member {string}

public cookiePath: any

Set to '/' if you want the cookie for the whole website

member

{any}

public expose: boolean

Whether to expose the elements at each step in the tour (requires modal:true)

member

{boolean}

public localStorage: boolean

true or false to control whether localstorage is used

member

{boolean}

public localStorageKey: string

Keyname in localstorage

member

{string}

public modal: boolean

Whether to cover page with modal during the tour

member

{boolean}

public nextButton: boolean

true/false for next button visibility

member

{boolean}

public nubPosition: any

override on a per tooltip bases

member

{any}

public pauseAfter: Array<any>

array of indexes where to pause the tour after

member

{any[]}

public postExposeCallback: (index: number, nextTip: JQuery, el?: JQuery) => void

A method to call after an element has been exposed

method

param

Tip Index

param

Tip object

param

Element

public postRideCallback: (index: number, currentTip: JQuery, isAborted?: boolean) => void

a method to call once the tour closes

method

param

Current Tip Index

param

Current Tip object

param

Is Aborted?

public postStepCallback: (index: number, currentTip: JQuery, isAborted?: boolean) => void

A method to call after each step

method

param

Current Tip Index

param

Current Tip object

param

Is Aborted?

public preRideCallback: (index: number, currentTip: JQuery, el?: JQuery) => void

A method to call before the tour starts (passed index, tip, and cloned exposed element)

method

param

Current Tip Index

param

Current Tip object

param

Element

public preStepCallback: (index: number, nextTip: JQuery, el?: JQuery) => void

A method to call before each step

method

param

Tip Index

param

Tip object

param

Element

public scroll: boolean

whether to scroll to tips

member

{boolean}

public scrollSpeed: number

Page scrolling speed in ms

member

{number}

public startOffset: number

the index of the tooltip you want to start on (index of the li)

member

{number}

public startTimerOnClick: boolean

true/false to start timer on first click

member

{boolean}

public template: JoyrideTemplate

HTML segments for tip layout

member

{JoyrideTemplate}

public timer: number

0 = off, all other numbers = time(ms)

member

{number}

public tipAnimation: string

'pop' or 'fade' in each tip

member

{string}

public tipAnimationFadeSpeed: number

if 'fade'- speed in ms of transition

member

{number}

public tipContainer: HTMLElement

Where the tip be attached if not inline

member

{HTMLElement}

public tipLocation: string

'top' or 'bottom' in relation to parent

member

{string}

public version: string

Version

member

{string}