Skip to main content

Hints options

Options​

hints​

For defining hints using JSON configuration. Array of hint objects.

hintPosition​

Hint position. Default: top-middle

hintButtonLabel​

Hint button label. Default: ‘Got it’

hintShowButton​

To show/hide the "Got it" button. Default: true

hintAutoRefreshInterval​

Hints auto-refresh interval in ms (set to -1 to disable). Default: 10

hintAnimation​

To add animation to hints or not. Default: true

Hint data structure​

{
    hint: 'text for the hint',
    element: element, // string query selector or DOMElement
    hintPosition: (Optional) Hint position. Default: `top-middle`
    hintAnimation: (Optional) To add animation to hints or not. Default: `true`
}

Updating options​

An example of adding an option:

introJs().setOption("hintButtonLabel", "OK");

An example of adding hints programmatically through options:

introJs().setOptions({
    hints: [
        { hint: 'First hint', element: '#new-feature' },
        { hint: 'Second hint', element: '#new-button', hintAnimation: false }
    ]
});