Poshy Tip jQuery Plugin Demo Page
Usage Examples
The default browser tooltip that displays the value of the title attribute is replaced with a "poshier" version:
$('#demo-basic').poshytip();
Styles (Classes)
Using different tooltip classes is easy. Here are some examples that are included in the download package (in the "src" folder).
$('#demo-tip-yellow').poshytip();
$('#demo-tip-violet').poshytip({
className: 'tip-violet',
bgImageFrameSize: 9
});
$('#demo-tip-darkgray').poshytip({
className: 'tip-darkgray',
bgImageFrameSize: 11,
offsetX: -25
});
$('#demo-tip-skyblue').poshytip({
className: 'tip-skyblue',
bgImageFrameSize: 9,
offsetX: 0,
offsetY: 20
});
.tip-yellowsimple (no background-image used for the tooltip body)
$('#demo-tip-yellowsimple').poshytip({
className: 'tip-yellowsimple',
showTimeout: 1,
alignTo: 'target',
alignX: 'center',
offsetY: 5,
allowTipHover: false
});
.tip-twitter (ala Twitter)
$('#demo-tip-twitter').poshytip({
className: 'tip-twitter',
showTimeout: 1,
alignTo: 'target',
alignX: 'center',
offsetY: 5,
allowTipHover: false,
fade: false,
slide: false
});
$('#demo-tip-green').poshytip({
className: 'tip-green',
offsetX: -7,
offsetY: 16,
allowTipHover: false
});
Form Tooltips (with varying positioning)
Adding form input field tooltips is simple. You just have to make sure they are triggered on focus/blur (i.e. showOn: 'focus') and positioned relatively to the target element (i.e. alignTo: 'target'). The script also updates the position of such tooltips if the window is resized (e.g. show some of the tips below and resize your browser window for a demo).
$('#demo-form-name').poshytip({
className: 'tip-yellowsimple',
showOn: 'focus',
alignTo: 'target',
alignX: 'right',
alignY: 'center',
offsetX: 5,
showTimeout: 100
});
$('#demo-form-email').poshytip({
className: 'tip-yellowsimple',
showOn: 'focus',
alignTo: 'target',
alignX: 'left',
alignY: 'center',
offsetX: 5,
showTimeout: 100
});
$('#demo-form-site').poshytip({
className: 'tip-yellowsimple',
showOn: 'focus',
alignTo: 'target',
alignX: 'inner-left',
offsetX: 0,
offsetY: 5,
showTimeout: 100
});
$('#demo-form-subject').poshytip({
className: 'tip-yellowsimple',
showOn: 'focus',
alignTo: 'target',
alignX: 'center',
alignY: 'bottom',
offsetX: 0,
offsetY: 5,
showTimeout: 100
});
Asynchronous Loading of the Content
Poshy Tip supports using a function for returning the tooltip content and the script also passes an update callback function as an argument to this function. By using this callback, you can easily update asynchronously the content of the tooltip after it has been displayed. The script also recalculates and updates the position of the tooltip when its content is updated.
Simple Example
$('#demo-async-timeout').poshytip({
content: function(updateCallback) {
window.setTimeout(function() {
updateCallback('Tooltip content updated!');
}, 1000);
return 'Loading...';
}
});
Loading Flickr Feeds
A more complicated example of loading some Flickr images by tags:
flowers, closeup, sunset, architecture, Plovdiv, old, town, Nesebar, depeche
var flickrFeedsCache = {};
$('#demo-async-flickr > a').poshytip({
className: 'tip-darkgray',
bgImageFrameSize: 11,
alignY: 'bottom',
content: function(updateCallback) {
var rel = $(this).attr('rel');
if (flickrFeedsCache[rel] && flickrFeedsCache[rel].container)
return flickrFeedsCache[rel].container;
if (!flickrFeedsCache[rel]) {
flickrFeedsCache[rel] = { container: null };
var tagsComma = rel.substring(4).replace('-', ',');
$.getJSON('http://api.flickr.com/services/feeds/photos_public.gne?tags=' + tagsComma + '&tagmode=all&format=json&jsoncallback=?',
function(data) {
var container = $('<div/>').addClass('flickr-thumbs');
$.each(data.items, function(i, item) {
$('<a/>')
.attr('href', item.link)
.append($('<img/>').attr('src', item.media.m))
.appendTo(container)
.data('tip', '<strong>' + (item.title || '(no title)') + '</strong><br />by: ' + item.author.match(/\((.*)\)/)[1]);
if (i == 4)
return false;
});
// add tips for the images inside the main tip
container.find('a').poshytip({
content: function(){return $(this).data('tip');},
className: 'tip-yellowsimple',
showTimeout: 100,
alignTo: 'target',
alignX: 'center',
alignY: 'bottom',
offsetY: 5,
allowTipHover: false,
hideAniDuration: 0
});
// store the content in the cache
// and call updateCallback() to update the content in the main tooltip
updateCallback(flickrFeedsCache[rel].container = container);
}
);
}
return 'Loading images...';
}
});
Following the Mouse Cursor
If using the followCursor: true option, it's better to make sure the the slide animation effect is disabled (i.e. slide: false) so that it doesn't conflict with the code that moves the tooltip with the cursor.
Hover for a tooltip that follows the cursor
$('#demo-follow-cursor').poshytip({
followCursor: true,
slide: false
});
API Example - Triggering the Tooltip Manually
If you like, you can add a tooltip to some element(s) and configure it to not be triggered automatically on hover or focus/blur by using the showOn: 'none' option. You can then control the tooltip manually via the available methods.
This link has a tooltip that is not triggered automatically
$('#demo-manual-trigger').poshytip({
content: 'Hey, there! This is a tooltip.',
showOn: 'none',
alignTo: 'target',
alignX: 'inner-left',
offsetX: 0,
offsetY: 5
});
$('#button-show').click(function() { $('#demo-manual-trigger').poshytip('show'); });
$('#button-show-delayed').click(function() { $('#demo-manual-trigger').poshytip('showDelayed', 2000); });
$('#button-hide').click(function() { $('#demo-manual-trigger').poshytip('hide'); });
$('#button-hide-delayed').click(function() { $('#demo-manual-trigger').poshytip('hideDelayed', 2000); });
$('#button-update').click(function() { $('#demo-manual-trigger').poshytip('update', 'I am a new content :)'); });
$('#button-disable').click(function() { $('#demo-manual-trigger').poshytip('disable'); });
$('#button-enable').click(function() { $('#demo-manual-trigger').poshytip('enable'); });
$('#button-destroy').click(function() { $('#demo-manual-trigger').poshytip('destroy'); });
Using Live Events
You can set the liveEvents: true option to use live events. Note that the API methods (except 'destroy') won't work reliably in such case. They will only work for the elements for which the tooltip has been initialized (i.e. shown at least once). Live events are supported in jQuery 1.4.2+.
$('#demo-live-events > a').poshytip({
liveEvents: true
});
$('#button-live-events').click(function() {
$('#demo-live-events').append(', <a title="Hey, there! This is a tooltip." href="#">Hover for a tooltip</a>');
});
Options
Methods
Notes
- Requires jQuery 1.4+
- Works in IE6+, FF 2+, Opera 9+, Safari 3+, Chrome
- In IE6 min/max-width are supported (only px values) for the tooltip container DIV so you can use them in your CSS without worrying for IE6 (if you still care about it)
- When a background-image is set for the tooltip container DIV, the script will neglect the background-color/padding/border declarations set for it and will use the background image to create a scalable frame around the tooltip inner DIV (for an explanation how this works, please take a look at the Poshy Tip Page)
- In IE6 PNG background images are not supported (only GIF). If a PNG is set as a background-image for the tooltip container, in IE6 the script will fallback and use the background-color/padding/border declarations instead.
License
Like jQuery, Poshy Tip is dual licensed under the MIT and GPL licenses.
Download
Download link: http://vadikom.com/files/?file=poshytip/poshytip-1.2.zip
Git
The Poshy Tip source code is also available at GitHub:
git clone git://github.com/vadikom/poshytip.git
Support
Post your questions/suggestions in the support forums.
Donate
If you appreciate this script, you can support me by donating a small amount through PayPal or just by spreading the word about it. Your support is highly appreciated!