Poshy Tip - jQuery Plugin for Stylish Tooltips

I almost hear you asking - why another jQuery tooltip plugin? Well, I actually never planned creating this plugin until I reached the final stages of designing this website and decided to add some pretty tooltips. So I started looking for a tooltip plugin that allows easily creating stylish tooltips and also includes the most useful features for such a script. However, I wasn't pleased with the results I found so I ended up writing a completely new plugin and am now making it available for all.

Demos

You might be eager to take a look at some examples so here is the demo page right away. And below you will find a short introduction.

Notable Features

OK, so apart from the awful name, is there anything interesting about this tooltip plugin?

A Single Background Image for Scalable Tooltips

Suppose you need to code a scalable tooltip that looks like this (i.e. a tooltip with auto width/height based on the content inside it):

A figure showing a tooltip mockup that should be used to create a scalable tooltip on the page

The Usual Approach

To achieve this with most similar plugins out there you would need to slice the image into multiple separate images - for the corners of the box, for the sides, etc.:

A figure showing how you would normally need to slice the mockup into 9 images in order to code a scalable tooltip

The Poshy Tip Approach

But since the tooltips only work when JavaScript is enabled anyway, why not apply some JS magic which would make our life easier and save our server some additional requests? This is exactly what Poshy Tip was designed to do. With this plugin, you can create a scalable tooltip by just using a single background image for the tooltip body:

With Poshy Tip you need just 2 images - one for the tooltip body + 1 for the arrow

You need to create one big image for the tooltip body - e.g. something like 1024x768 pixels (which should be enough for anything you may want to display inside a tooltip in the browser viewport). You then have to set it as a background image for the tooltip container DIV in the most trivial way:

.tip-yellow {
	...
	background-image: url(tip-yellow.png);
}

Poshy Tip detects when a background image has been set for the tooltip container DIV and creates a scalable frame from it that wraps the inner contents of the tip. Finally, you just need to specify what should be the size of the background image frame around the inner content by setting the following option:

bgImageFrameSize: 10 // pixels

And the result:

A figure showing the scalable frame created from the background image that wraps the inner DIV

You can, of course, tweak the margin/padding of the inner DIV if needed.

Advanced Positioning Options

With Poshy Tip you can position the tips relative to the mouse cursor or to the target element and align them in every possible way horizontally and vertically (note the alignTo, alignX and alignY options). In addition the script makes sure the tips are always displayed in the browser viewport and also automatically positions the arrow (if available) on the appropriate side of the tooltip body.

Asynchronous Loading of the Tooltip 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. You can see a quick example on the demo page.

Documentation

You can find usage examples and a list of the options and methods available on the demo page.

License

Like jQuery, Poshy Tip is dual licensed under the MIT and GPL licenses.

Git

The Poshy Tip source code is also available at GitHub:

git clone git://github.com/vadikom/poshytip.git

Liked this post?

Don't wait & subscribe to RSS or email updates now.
Quick Tip: Sharing is also easy with the share menu below. :)

Comments:

  • Looks nice, but the default title behavier of the browser should be disabled.
    Mouseover on an input field show the title, then click on the input field show poshy tip.

    #20 by: otter on July 30, 2010 at 15:07
  • admin

    @bartaz: Yep, these are good points. But as Michiel mentions, the image can be optimized and actually it might even be much smaller than 1024x768 in most cases if needed (at least in height usually).

    Also I believe you'd agree that although CSS3 really allows much it's still not possible to cover all possible designs you could with an image.

    BTW, the script doesn't limit the use of CSS3 features in any way. :) You can see that some of the demos use border-radius and no background image (just an arrow).

    #19 by: Vasil Dinkov on July 29, 2010 at 19:10
  • It's very good !! Thank!

    #18 by: Luigi on July 29, 2010 at 15:31
  • @bartaz: You do have a point there. However, a big image shouldn't be a big problem if you pick the right file format and make the image simple enough (e.g. no noisy background).

    Although I too prefer CSS3 over images. But I still like this plugin alot!

    #17 by: Michiel on July 29, 2010 at 14:53
  • Really like it! I'm sure I'll be using it somewhere, thanks!

    #16 by: Michiel on July 29, 2010 at 14:50
  • I'm not sure if creating and downloading '1024x768 pixels' pixels image is such a good solution. That's a huge thing to load!

    Most of the browsers nicely support CSS3 rounded corners, shadows, etc. Why not just forget about images?

    #15 by: bartaz on July 29, 2010 at 14:44
  • admin

    Thanks guys!

    Happy to hear you like it! :)

    #14 by: Vasil Dinkov on July 29, 2010 at 14:37
  • Some things are just perfect. This is one of them.

    Many thanks for creating this. You are absolutely right - there were many tooltip plugins, but you nailed how it should be done.

    #13 by: irakli on July 29, 2010 at 06:11
  • Naaaaaaais!

    #12 by: Levi on July 29, 2010 at 01:48
  • Wonderful approach and great coding :)
    really well done ;)

    #11 by: loige on July 29, 2010 at 00:49
  • We are about halfway through the year, and the technological world has
    progressed by leaps and bounds already. So much so, that in their
    effort to keep up with

    #10 by: kumar on July 28, 2010 at 20:01
  • Very slick. will have a play with this today. Many thanks

    #9 by: steve on July 28, 2010 at 02:39