JSDoc: o-tooltip

new Tooltip(tooltipEl, opts)

Represents a tooltip.

Methods

• getOptions(tooltipEl) - (static) Get the data attributes from the tooltipEl. If the tooltip is being set up declaratively, this method is used to extract the data attributes from the DOM.
• checkOptions(opts) - (static) Check the options passed in are valid, and that the required option (target) is present
• render - (instance) Render the tooltip. Adds markup and attributes to this.tooltipEl in the DOM
• show - (instance) Show the tooltip. Adds event handlers for clicks, touches, keypresses and viewport resizes. Uses FTDomDelegate to implement the event delegate pattern. Calls DrawTooltip.
• toggle - (instance) Toggle the tooltip open and close
• closeAfter(seconds) - (instance) Close the tooltip after set time
• showAfter(seconds) - (instance) Show the tooltip after set time
• destroy - (instance) Destroy the tooltip.
• close(...) - (instance) Close the tooltip. (Visually hide it and remove event listeners)
• closeOnKeyUp(ev)
• resizeListener - (instance) Respond to resize events. Redraw the tooltip in case the target has moved.
• drawTooltip - (instance) Calculates the best place to position the tooltip based on space around the target and a preference set by the app developer.
• width
• height

Links

• "Tooltip" class on Github

Tooltip.getOptions(tooltipEl)

Static Method

Get the data attributes from the tooltipEl. If the tooltip is being set up declaratively, this method is used to extract the data attributes from the DOM.

Returns

• Object.<string, any> - a dictionary of options

Links

• "getOptions" function on Github

Tooltip.checkOptions(opts)

Static Method

Check the options passed in are valid, and that the required option (target) is present

Returns

• object - opts

Links

• "checkOptions" function on Github

Tooltip#render

Instance Method

Render the tooltip. Adds markup and attributes to this.tooltipEl in the DOM

Links

• "render" function on Github

Tooltip#show

Instance Method

Show the tooltip. Adds event handlers for clicks, touches, keypresses and viewport resizes. Uses FTDomDelegate to implement the event delegate pattern. Calls DrawTooltip.

Links

• "show" function on Github

Tooltip#toggle

Instance Method

Toggle the tooltip open and close

Links

• "toggle" function on Github

Tooltip#closeAfter(seconds)

Instance Method

Close the tooltip after set time

Links

• "closeAfter" function on Github

Tooltip#showAfter(seconds)

Instance Method

Show the tooltip after set time

Links

• "showAfter" function on Github

Tooltip#destroy

Instance Method

Destroy the tooltip.

Links

• "destroy" function on Github

Tooltip#close(...)

Instance Method

Close the tooltip. (Visually hide it and remove event listeners)

Returns

• boolean - false

Links

• "close" function on Github

Tooltip#closeOnKeyUp(ev)

Instance Method

Links

• "closeOnKeyUp" function on Github

Tooltip#resizeListener

Instance Method

Respond to resize events. Redraw the tooltip in case the target has moved.

Links

• "resizeListener" function on Github

Tooltip#drawTooltip

Instance Method

Calculates the best place to position the tooltip based on space around the target and a preference set by the app developer.

Returns

• void - this function is recursive!

Links

• "drawTooltip" function on Github

Tooltip#width

Instance Method

Returns

• number - the offset width of the tooltip element

Links

• "width" function on Github

Tooltip#height

Instance Method

Returns

• number - the offset height of the tooltip element

Links

• "height" function on Github