Web Notifications made easy

• Overview
• Demo
• Usage
• Installation
• Limitations
• API Documentation
• Contributing
• Release History
• License

The simple-web-notification is a simplified web notifications API with automatic permissions support.

This library requires no external dependencies, however the browser must support the Notification API or have a polyfill available.

See W3 Specification for more information.

Live Demo

In order to use the simplified web notification API you first must add the relevant dependencies:

<script type="text/javascript" src="web-notification.js"></script>

Now you can use the API anywhere in your application, for example:

$('.some-button').on('click', function onClick() {
    webNotification.showNotification('Example Notification', {
        body: 'Notification Text...',
        icon: 'my-icon.ico',
        onClick: function onNotificationClicked() {
            console.log('Notification clicked.');
        },
        autoClose: 4000 //auto close the notification after 4 seconds (you can manually close it via hide function)
    }, function onShow(error, hide) {
        if (error) {
            window.alert('Unable to show notification: ' + error.message);
        } else {
            console.log('Notification Shown.');

            setTimeout(function hideNotification() {
                console.log('Hiding notification....');
                hide(); //manually close the notification (you can skip this if you use the autoClose option)
            }, 5000);
        }
    });
});

When using an AMD loader (such as RequireJS) or CommonJS type loader, the webNotification object is not automatically defined on the window scope.

Run bower install in your project as follows:

bower install simple-web-notification --save

Or if you are using NPM to download client libraries, you can install it as follows:

npm install --save simple-web-notification

The web notifications API is not fully supported in all browsers.

Please see supported browser versions for more information on the official spec support.

See full docs at: API Docs

See contributing guide

Developed by Sagie Gur-Ari and licensed under the Apache 2 open source license.