Skip to content

breity/jquery-powertip

 
 

Repository files navigation

PowerTip - A jQuery plugin that creates hover tooltips.

PowerTip is a jQuery tooltip plugin with some advanced features like hover intent testing, tooltip queueing, and support for complex data. It also has that rarest of features in jQuery plugins, it's not abandonware.

Build Status

Getting Started

  • Download the latest stable release from the PowerTip web site.
  • Add the js and css references to your web site.
  • Add a title or data-powertip attribute to the elements you want to show tooltips for.
  • Run the powerTip() method on those elements.

Documentation

You can find the documentation for the latest release version on the PowerTip web site. You will find the documentation for the latest in-development version in the doc folder in this repository.

Reporting Bugs

For bug reports, questions, feature requests, or other suggestions the best way to contact me is to create an issue on GitHub. If you don't want to use GitHub or want to contact me about something else please feel free to contact me via twitter at @stevenbenner. As with all open source projects: pull request > bug report > tweet.

Contributor Guide

Make PowerTip better! Join the leage of awesome today by submitting a patch! The best way to submit patches is to fork this project on GitHub and submit a pull request. But if you are unwilling or unable to use GitHub I will accept patches in any way you can get them to me (jsFiddle, pastebin, text file, whatever).

Style Guide

These are general guidelines, not rules. I won't refuse a pull request just because it isn't the exact style that I use.

  • Style guide: In general, follow the Google JavaScript Style Guide.
  • Line wrap: Soft-wrap at 80 characters (go further if wrapping makes code less readable).
  • Indentation: Use tabs for indentation.
  • JSDoc comments: Use closure compiler annotations.
  • Method chaining: Avoid long chained method statements, two or three max.

Change Log

v1.2.0 - Major release with lots of improvements and a significant code rewrite (TBD)

IN-DEVELOPMENT - Not yet released

  • Features & Improvements
    • Mouse-follow tooltips will now flip out of the way if they become trapped in the bottom-right corner.
    • Escape key will now close tooltip for selected element.
    • Added support for elastic tooltips.
    • Added manual option to disable the built-in event listeners.
    • Added nw-alt, ne-alt, sw-alt, and se-alt placement options.
    • Added support for SVG elements.
    • PowerTip will now use right position for right aligned tooltips.
    • Data attributes powertip and powertipjq now accept a function.
    • powerTip() will now overwrite any previous powerTip() calls on an element.
    • Added keepAlive option to prevent automatic hiding of tooltips on mouseleave events.
  • API
    • Added show() and hide() methods to the API.
    • Added reposition() method to the API.
    • Added destroy() method to the API.
    • You can now pass API method names as strings to the powerTip() function.
    • showTip and hideTip API methods are now deprecated in favor of the new show and hide API methods (but they will continue to work until 2.0).
  • CSS
    • Added 8 new tooltip CSS themes.
    • Changed default z-index in CSS themes to int max.
    • Added RGB color fallbacks for tooltip arrows (meaning arrows arrows now work in IE8).
  • Bug Fixes
    • Fixed bug that would cause the CSS position to be updated even when the tooltip is closed.
    • Fixed issue that could cause tooltips to close prematurely during the closeDelay period.
  • Miscellaneous
    • Project now has a fully automated build process.
    • Added a complete test suite and hooked up Travis CI.
    • Significant rewrite of the code.

v1.1.0 - Major release with several significant improvements (August 8, 2012)

  • Features & Improvements
    • Added smart placement feature.
    • Added custom events.
    • Added support for keyboard navigation.
    • Added support for jsFiddle.
  • API
    • Added API with showTip() and closeTip() methods.
  • Bug Fixes
    • Fixed mouse-follow constraint

v1.0.4 - Minor release to address issues with IE8 (July 31, 2012)

  • CSS
    • Added RBG background color fallback for browsers that do not support RGBA.
  • Bug Fixes
    • Fixed positioning problems with Internet Explorer 8.

v1.0.3 - Minor release to address a couple issues (July 31, 2012)

  • Features & Improvements
    • Added mouse position tracking to scroll events.
  • Bug Fixes
    • Fixed rare issue that would make fixed placement tooltips follow the mouse.

v1.0.2 - Minor release to make a couple small improvements and bug fixes (July 26, 2012)

  • Features & Improvements
    • Added placement class to tooltip element.
    • Added CSS arrows to tooltips.
    • Add nw, ne, sw, and sw placement options.
    • Changed default closeDelay to 100ms.
    • Changed default fadeOutTime to 100ms.
    • Changed default placement to north.
  • Bug Fixes
    • Fixed error when there is no tooltip content.
    • Fixed rare error when moused entered a tooltip during its fadeOut cycle.

v1.0.1 - Minor release to fix a tip tracking issue (July 11, 2012)

  • Bug Fixes
    • Fixed rare issue that caused tooltips to become desynced.

v1.0.0 - Initial public release (July 1, 2012)

  • Initial public release

License

(This project is released under the MIT license.)

Copyright (c) 2013 Steven Benner (http://stevenbenner.com/)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

A jQuery plugin that creates hover tooltips.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%