https://github.com/adam-lynch/nodeifications

Simple cross platform desktop notifications for node-webkit
https://github.com/adam-lynch/nodeifications

Last synced: about 1 month ago
JSON representation

Simple cross platform desktop notifications for node-webkit

• Host: GitHub
• URL: https://github.com/adam-lynch/nodeifications
• Owner: adam-lynch
• Created: 2014-08-03T01:00:07.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-08-03T02:24:10.000Z (over 10 years ago)
• Last Synced: 2024-10-20T02:46:24.204Z (3 months ago)
• Language: CSS
• Size: 5.16 MB
• Stars: 3
• Watchers: 5
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Nodeifications

Simple cross platform desktop notifications for [node-webkit](https://github.com/rogerwang/node-webkit) apps, inspired by [Chrome Notifications](https://developer.chrome.com/apps/notifications).

![Nodeifications Intro Banner](doc/images/nodeifications-wide.jpg)

[Documentation](https://github.com/pbojinov/nodeifications/wiki/Getting-Started) on the wiki

## Getting Started

1. Include the javascript `nw-desktop-notifications.js` in your application

2. Include the HTML template `nw-desktop-notifications.html` in your application

3. Create a notification using the API: `DEA.notifications.create(options, callback);`

## Running the demo

(1) Clone this project

(2) cd into the project /src

(3) Make the nw zip file by running the bash script

	./make-nw.sh

(4) Run the nw application

	node-webkit desktop-notify.nw

## Building for Production

From the root of the project:

	npm install

	grunt build

Then run the executable/app from /webkitbuilds/release/NW Desktop Notifications Demo

## Application Flow

1. Call the API to create a new notification.

2. `nw-desktop-notifications.js` creates the HTML template using the user provided content

3. `nw-desktop-notifications.js` created the notification and appends the template to the created notification window.

4. `nw-desktop-notifications.html` is simply the container for the content. It handles closing itself and sending off interaction events back to the parent who initiated the notification.

## Notification Types

### Text

![Text Notification](doc/images/text_notification.png)

### Image

![Image Notification](doc/images/image_notification.png)