Skip to content

Latest commit

 

History

History
75 lines (57 loc) · 4.33 KB

README.md

File metadata and controls

75 lines (57 loc) · 4.33 KB

qTip2 - Pretty powerful tooltips

Introducing… qTip2. The second generation of the advanced qTip plugin for the ever popular jQuery framework.

Building on 1.0's user friendly, yet feature rich base, qTip2 provides you with tonnes of features like speech bubble tips and imagemap support, and best of all... it's completely free under the MIT/GPLv2 licenses!

More documentation and information is available at the official site.

Browser support

8+       3+       6+       9+       2+, iOS 4+

Getting qTip2

Stable releases

You can grab the latest stable releases from the download page of the official site. This also lets you choose what plugins you'd like included in your download, as well as other things.

Bleeding edge

You can grab the latest and greatest qTip2 nightly from the dist directory and get started quickly. If you want more options over what plugins are included in your build, take a look below.

Download the production version or the development version.

Custom builds

You can also build your own qTip2 script that includes select plugins and styles to reduce the overall file size and remove features you don't plan on using. Find more information about this here

Installation

Now you have the jQuery library and qTip2 files, it's time to include them within your HTML. I highly recommend that all JavaScript includes be placed just before the end </body> tag as this ensures the DOM is loaded before manipulation of it occurs. This is not a requirement, simply an insiders tip!

<html>
<head>
<title>My site</title>
<!-- css file -->
<link type="text/css" rel="stylesheet" href="/path/to/jquery.qtip-2.0.0.css" />
</head>
<body>
<!-- content here -->
<script type="text/javascript" src="/path/to/jquery.1.4.2.min.js"></script>

<!-- Notice we only include the minified script here. You can include the non-minified version, just don't include both! -->
<script type="text/javascript" src="/path/to/jquery.qtip-2.0.0.min.js"></script>
</body>
</html>

Note: Make sure to include either the non-minified or the un-minified script, not both!
Note: Notice *the jQuery library is included before qTip2. This is absolutely essential for correct functioning of the plugin!

Release History

(Nothing yet)

Questions or problems?

If you have any questions, please feel free to post on the support forums, but before you do make sure to check out the thorough documentation both here in the repo and on the official site.

License

Copyright (c) 2012 Craig Michael Thompson. Licensed under the MIT, GPL licenses. See here for more details.

Special thanks

Big shout-out to "Cowboy" Ben Alman for providing the grunt build system used by qTip2