mouse

The mouse module provides three event listener functions for mouseover, mouseout, and mousemove events. Additionally, it provides a suspend function which is exposed by the default object, which is exported in index.js.

Source:

Members

(inner) timer :number

Source:

Countdown timer that executes a on mouseout event to ensure that the .fxToolTip visibility CSS rule is not set to hidden until the current tooltip's transition to hidden is completed.

Type:
  • number

(inner) suspended :boolean

Source:

Current state of the suspended toggle.

Type:
  • boolean

Methods

(inner) getMouseCoordinates(event)

Source:

Internal helper function which retrieves the current X and Y coordinates in the client window and stores them in the global variables mouseX and mouseY.

Parameters:
Name Type Description
event Event

The firing window event

(inner) suspend(suspendTips) → {boolean|undefined}

Source:

This method is useful for temporarily suspending and re-enabling tooltips globally in such cases where other on-screen interaction may be interfered with by the tooltips.

Parameters:
Name Type Description
suspendTips boolean

Whether or not to suspend toolTips.
Returns:

If the method is called without the suspendTips argument, the method returns the current state of tooltips (true for suspended, false for enabled). Otherwise, nothing is returned.

Type
boolean | undefined

Events

mouseover

Source:

Fires when the cursor hovers over a DOM element that has a tooltip associated with it.

Parameters:
Name Type Description
event Event

The firing event.

mousemove

Source:

Fires when the cursor moves over a DOM element that has a tooltip associated with it.

Parameters:
Name Type Description
event event

The firing window event.

mouseout

Source:

Fires when the cursor leaves a DOM element that has a tooltip associated with it.

Parameters:
Name Type Description
event event

The firing window event.