File: README

package info (click to toggle)
jquery-goodies 11-3
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 4,188 kB
  • ctags: 521
  • sloc: xml: 308; makefile: 89; php: 48; sql: 39
file content (44 lines) | stat: -rw-r--r-- 1,317 bytes parent folder | download | duplicates (10)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
tipsy - Facebook-style tooltip plugin for jQuery
	(c) 2008-2010 Jason Frame (jason@onehackoranother.com)
	Released under The MIT License.

== DESCRIPTION:

tipsy is a simple jQuery plugin for generating Facebook-style tooltips.

It's used by Twitter, Github and Bitbucket, amongst others.

== HOMEPAGE:

http://onehackoranother.com/projects/jquery/tipsy

== SOURCE:

Hosted at GitHub; browse at:

  http://github.com/jaz303/tipsy/tree/master

Or clone from:

  git://github.com/jaz303/tipsy.git

== USAGE:

1. Copy the contents of src/{images,javascripts,stylesheets} to the corresponding asset directories in your project. If the relative path of your images directory from your stylesheets directory is not "../images", you'll need to adjust tipsy.css appropriately.

2. Insert the neccesary elements in your document's <head> section, e.g.:

<script type='text/javascript' src='/javascripts/jquery.tipsy.js'></script>
<link rel="stylesheet" href="/stylesheets/tipsy.css" type="text/css" />

Remember to include jquery.tipsy.js *after* including the main jQuery library.

3. Initialise Tipsy in your document.onload, e.g.:

<script type='text/javascript'>
	$(function() {
		$('a[rel=tipsy]').tipsy({fade: true, gravity: 'n'});
	});
</script>

Please refer to the docs directory for more examples and documentation.