koosvanderkolk / jquery.notify.js Goto Github PK

======================================
jQuery Notify Plugin 2 - v0.1 - by @koosvdkolk
======================================

Attempts to implement notifications similar to those available in
Ubuntu since Jaunty Jackalope (9.04) [see: $ aptitude show notify-osd]

For more information on the notifications, see the following:
 - http://www.markshuttleworth.com/archives/253
 - http://launchpad.net/notify-osd

Dependencies: jQuery 1.3
              jquery.jcorners.js

Copyright (c) 2012 Koos van der Kolk
Dual licensed under the MIT and GPL licenses (same as jQuery).
http://docs.jquery.com/License

Based on the jQuery Notify Plugin by https://github.com/caolan

==================
Installation
------------------

Include notify.css and jquery.notify.js in your HTML. You'll also need,
jquery-1.3.2.js (or latest jquery 1.3 release) and jquery.jcorners.js.

You can get jquery.jcorners.js from:
http://plugins.jquery.com/project/JCorners


==================
Usage
------------------

You can then create notifications by calling $.notify(options), where
options is an object with some or all or the attributes: title, text, icon,
delay (in millisecs), sticky (boolean), closeOnClick (boolean), 
parentElement (DOM element).

Example: $.notify({title:'Example', text:'Lorem ipsum...', icon:'image.png'});


==================
Supported Browsers
------------------

Tested and working on:
    
    FF3 (Windows XP & Ubuntu)
    IE7
    IE6
    Safari 3.2.1 (Windows XP)
    Opera 10.0 (Windows XP)

Additional testing would be welcome, if you have any more results
to add please get in touch.


==================
Known Issues
------------------

Browser security error if opened as a local file instead of run through a
webserver. Most other issues are due to ongoing development on handling 
CSS for elements behind the notifications. Active and focus CSS properties
are not currently supported, and hover styles are only partially supported.

If you have any problems, please submit an Issue on GitHub.