public
Fork of tdreyno/prototypegrowl
Description: Prototype & Scriptaculous implementation of the OS X growl notification bubbles
Homepage: http://www.craigjolicoeur.com/pgrowl
Clone URL: git://github.com/cpjolicoeur/prototypegrowl.git
Search Repo:
name age message
folder README Sat Apr 05 19:48:38 -0700 2008 updated docs [cpjolicoeur]
folder effects.js Fri Apr 04 18:51:11 -0700 2008 add scriptaculous and use Appear/Fade effect fo... [cpjolicoeur]
folder growl.css Sat Apr 05 19:48:38 -0700 2008 updated docs [cpjolicoeur]
folder growl.js Tue Apr 22 13:27:39 -0700 2008 document.body.insert was throwing an error in IE6 [cpjolicoeur]
folder logo.png Sat Apr 05 06:10:05 -0700 2008 add new logo and update some copy [cpjolicoeur]
folder prototype-1.6.0.2.js Fri Apr 04 16:56:22 -0700 2008 import [Thomas Reynolds]
folder smoke.png Fri Apr 04 19:11:35 -0700 2008 add local images [cpjolicoeur]
folder test.html Sat Apr 05 19:55:07 -0700 2008 update example code in test file [cpjolicoeur]
README
== Description == 

prototypeGrowl is an implementation of the Mac OS X Growl notification system 
using the Prototype javascript library.


== Authors ==

Thomas Reynolds <tdreyno@gmail.com - http://github.com/tdreyno>
Craig P Jolicoeur <cpjolicoeur@gmail.com - http://github.com/cpjolicoeur>


== Usage ==

to create a new growl use the following code:

var growl = new Growl.Smoke;
growl.show({option: value});

The following option:value pairs can be set:

image:     'path to image file to use in growl bubble' 
title:     'title of growl bubble'
content:  'message for growl bubble'
autohide:  time in seconds to display the growl bubble (set to 0 to keep visible until clicked)
animated:  time in seconds of fade in / fade out animation (set to 0 to prevent animation)
opacity:  value from 0 - 1 of opacity of growl bubble


== Misc ==

Much thanks to the following javascript growl implementations for ideas and inspiration:

Window.Growl (mootools) - http://icebeat.bitacoras.com/mootools/growl/
protoGrowl (prototype)  - http://www.midgard-project.org/documentation/protogrowl
Growl (jquery)          - http://alexsancho.name/archives/2006/11/windowgrowl-con-jquery/
yowl (YUI)              - http://code.google.com/p/yowl/


== TODO ==

* If using Effects, do a sanity check to make sure the needed libraries
are included.