Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Link to demo no longer works. Added a quick Usage #25

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 25 additions & 2 deletions README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

Create Growl/Ubuntu-like notifications. Uses RGBA, border-radius, and box-shadow, so they're not as pretty as they could be in IE at the moment.

See [http://www.erichynds.com/jquery/a-jquery-ui-growl-ubuntu-notification-widget/](http://www.erichynds.com/jquery/a-jquery-ui-growl-ubuntu-notification-widget/) for demos & documentation.

## Features

- No images, all CSS
Expand All @@ -17,3 +15,28 @@ See [http://www.erichynds.com/jquery/a-jquery-ui-growl-ubuntu-notification-widge
- Ability to programatically call `open` and `close` methods
- Passes JSLint
- Cross-browser compatible (including IE6)

## Usage

```html
<div id="notify" style="display:none; width:400px;">
<div id="success-template">
<a class="ui-notify-cross ui-notify-close" href="#">x</a>
<h1>#{title}</h1>
<p>#{text}</p>
</div>
</div>
```

```javascript
$("#notify").notify({
speed: 500,
expires: 8000 // ms or false
});

$("#notify").notify("create", {
title: 'Cool Notification',
text: 'Order confirmed.'
});
```