My favorites | Sign in
Project Home Downloads Wiki Issues Source
Search
for
Documentation  
Documentation and tooltip options
Featured, Phase-Implementation, Phase-Deploy
Updated Feb 4, 2010 by Crag...@gmail.com

Simpletip - Documentation

Here's a full list of all available configuration options

Name Description Possible values Default value
content The HTML content which will appear inside the tooltip. Valid HTML A simple tooltip
persistent If set to true the tooltip will activate onclick rather than the default onhover behaviour. true or false false
focus For use with the persistent config option. If set to true the tooltip will stay active (on screen) until the document is clicked elsewhere. If false, tooltip will also close when clicked. true or false false
hidden If set to false the tooltip will be shown immediately when created. Works well with persistent. true or false true
position Determines how the tooltip is positioned relative to the element it is shown on. An array of x, y can be used set an absolute position. Encapsulating them in a string e.g. ["0", "0"] causes the positioning to be done relative to the top left corner of the root element. An HTML element can also be passed as an argument and it's current position assumed by the tooltip. default top, bottom, left, right, absolute: [x, y], relative: ["x", "y"], mixed: ["x", y] / [x, "y"], HTML element, default
offset Array of x, y by which to offset the tooltips position relative to that calculated by the position property. Array of any 2 integers [0, 0]
boundryCheck If true positioning will take into account window height and width to ensure tooltip does not scroll off page e.g. is always visible. NOTE: Set this to false if your experiencing jittering on non-fixed tooltips true or false true
fixed If set to false the tooltip moves with mouse as long as mouse is hovered over the root element. true or false true
showEffect Type of show effect to use. fade, slide, none fade
hideEffect Type of hide effect to use. fade, slide, none fade
showTime Time in milliseconds for showEffect effect. Positive integer 150
hideTime Time in milliseconds for hideEffect effect. Positive integer 150
showCustom Used along with the showEffect: 'custom' property. Custom method called when tooltip is shown. Defined method null
hideCustom Used along with the hideEffect: 'custom' property. Custom method called when tooltip is hidden. Defined method null
baseClass Class name to apply to generated tooltip elements supplied without the dot prefix. Any valid class name tooltip
activeClass Class name to apply to active (currently shown) tooltip elements supplied without the dot prefix. Any valid class name active
fixedClass Class name to apply to tooltip elements which move with the mouse i.e. non-static supplied without the dot prefix. Any valid class name fixed
persistentClass Class name to apply to presistent tooltip elements supplied without the dot prefix. Any valid class name persistent
focusClass Class name to apply to persistent focus tooltip elements supplied without the dot prefix. Any valid class name focus
onBeforeShow Callback method to execute before tooltip is shown. Defined method function(){}
onShow Callback method to execute after tooltip is shown. Defined method function(){}
onBeforeHide Callback method to execute before tooltip is hidden. Defined method function(){}
onHide Callback method to execute after tooltip is hidden. Defined method function(){}
beforeContentLoad Callback method to execute before content is loaded using the load method. Defined method function(){}
onContentLoad Callback method to execute after content is loaded using the load method. Defined method function(){}


Sign in to add a comment
Powered by Google Project Hosting