Skip to content

Latest commit

 

History

History
85 lines (60 loc) · 2.33 KB

README.md

File metadata and controls

85 lines (60 loc) · 2.33 KB

Notify.js

Build Status

A handy wrapper for using the Web Notifications API. Notify.js automatically handles requesting user permission and associated Web Notification API events, as well as adding a few extra convenience methods.

Installation

  • Download: zip
  • Bower: bower install notify.js
  • Git: git clone https://github.com/alexgibson/notify.js

Setup

This component can be used as an AMD module, or a global.

To initialize a web notification create a new Notify instance, passing the message title as well as any other options you wish to use.

var myNotification = new Notify('Yo dawg!', {
	body: 'This is an awesome notification',
	notifyShow: onNotifyShow
});

function onNotifyShow() {
	console.log('notification was shown!');
}

Then show the notification.

myNotification.show();

Required parameters

  • title (string) - notification title

Optional parameters

  • body: (string) - notification message body
  • icon: (string) - path for icon to display in notification
  • tag: (string) - unique identifier to stop duplicate notifications
  • notifyShow: (function) - callback when notification is shown
  • notifyClose: (function) - callback when notification is closed
  • notifyClick: (function) - callback when notification is clicked
  • notifyError: (function) - callback when notification throws an error
  • permissionDenied: (function) - callback when user has denied permission

Note: Firefox OS currently supports notifyClose and notifyClick callbacks only.

Useful methods

  • isSupported() - (returns boolean) test for Web Notifications API browser support

Testing

Install Node. Testing relies on the Karma test-runner, which can be installed globally using the following command.

npm install -g karma

In the project root, to perform a single pass of the tests using Firefox run:

npm test

Browser support

  • Chrome (desktop)
  • Safari
  • Firefox
  • Firefox OS
  • Firefox Mobile (Android)