intro.js
    Preparing search index...

    Generic package interface.

    Implements

    Index

    Constructors

    • Create a new Hint instance

      Parameters

      • OptionalelementOrSelector: string | HTMLElement

        Optional target element or CSS query to start the Hint on

      • Optionaloptions: Partial<HintOptions>

        Optional Hint options

      Returns Hint

    Methods

    • Get the callback function for the provided callback name

      Type Parameters

      • K extends "hintsAdded" | "hintClick" | "hintClose"

      Parameters

      • callbackName: K

        The name of the callback

      Returns
          | undefined
          | {
              hintClick?: hintClickCallback;
              hintClose?: hintCloseCallback;
              hintsAdded?: hintsAddedCallback;
          }[K]

    • 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)

      Returns Hint

    • Disable closing the dialog when the user clicks outside the hint

      Returns void

    • Enable closing the dialog when the user clicks outside the hint

      Returns void

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

      Returns State<undefined | number>

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

      Returns State<number>

    • Parameters

      • providedCallback: hintClickCallback

      Returns void

      onhintclick is deprecated, please use onHintClick instead

    • Callback for when hint items are clicked

      Parameters

      • providedCallback: hintClickCallback

        callback function

      Returns Hint

    • Parameters

      • providedCallback: hintCloseCallback

      Returns void

      onhintclose is deprecated, please use onHintClose instead

    • Callback for when hint items are closed

      Parameters

      • providedCallback: hintCloseCallback

        callback function

      Returns Hint

    • Parameters

      • providedCallback: hintsAddedCallback

        callback function

      Returns void

      onhintsadded is deprecated, please use onHintsAdded instead

    • 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.

      Parameters

      • stepId: number

        The hint step ID

      Returns Hint

    • Show hint dialog for a specific hint

      Parameters

      • stepId: number

        The hint step ID

      Returns Promise<undefined | Hint>