GitHub - vanntastic/tipsy: Facebook-style tooltips plugin for jQuery

Branches Tags

Name		Name	Last commit message	Last commit date
Latest commit History 22 Commits
docs		docs
src		src
.gitignore		.gitignore
LICENSE		LICENSE
README		README
Rakefile		Rakefile
project.yml		project.yml

Repository files navigation

tipsy - Facebook-style tooltip plugin for jQuery
	(c) 2008 Jason Frame (jason@onehackoranother.com)
	Released under The MIT License.

== DESCRIPTION:

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

== 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'});
	});
	
  // if you want to apply it to anything with a title
  $('a').each(function(index) {
    if ($(this).attr('title') != "") {
      $(this).tipsy({fade: false, gravity: 'n'});
    };
  });
    
</script>

== Installing for a rails project

A rake file has been included to easily install this plugin for a rails project, here's how you do it:

1. Make sure that the tipsy source is in public/javascripts/tipsy, you can actually just do:
  
  # assuming you're at the root of your rails project:
  cd public/javascripts
  git clone git://github.com/vanntastic/tipsy.git
  cd tipsy

2. Run:
  
  rake tipsy:install
  
3. Add the following into your layout file:

  <%= javascript_include_tag 'jquery.tipsy.js' %>
  <%= stylesheet_link_tag 'tipsy' %>
  
Please refer to the docs directory for more examples and documentation.