Class Hint

Create a new Hint instance

Add a Hint item

Get the callback function for the provided callback name

Clone the Hint instance

Destroys and removes all hint elements on the page Useful when you want to destroy the elements and add them again (e.g. a modal or popup)

Disable closing the dialog when the user clicks outside the hint

Disable hint auto refresh on page scroll and resize for hints

Enable closing the dialog when the user clicks outside the hint

Enable hint auto refresh on page scroll and resize for hints

Get the active hint signal This is meant to be used internally by the Hint package

Get the Hint item for the provided step ID

Get the Hint items

Get specific Hint option

Returns the underlying state of the refreshes This is an internal method and should not be used outside of the package.

Get the target element for the Hint

Hide a specific hint on the page

Hide hint dialog from the page

Calls the hintDialogClose callback (if any) with the hint item whose dialog was open, regardless of why it's closing - clicking outside it, toggling the same hint again, opening a different hint's dialog, or calling this directly. hideHint() also goes through here, so it fires this too, in addition to its own hintClose callback.

Hide all hints on the page

Returns true if the Hint is active

Returns true if the hints are rendered

Callback for when hint items are clicked

Callback for when hint items are closed

Callback for when a hint's dialog is closed, whether by clicking outside it, toggling the same hint again, opening a different hint's dialog, calling hideHintDialog() directly, or via hideHint()/the dialog's own close button (which also fires hintClose)

Refresh the hints on the page

Remove one single hint element from the page Useful when you want to destroy the element and add them again (e.g. a modal or popup) Use removeHints if you want to remove all elements.

Render hints on the page

Set the Hint items

Set specific Hint option

Set Hint options

Show a specific hint on the page

Show hint dialog for a specific hint

Show all hints on the page