/angular-notifications

An AngularJS component for easily creating notifications. Can also use HTML5 notifications.

Primary LanguageJavaScript

AngularJS Notifications

v0.2

Dependencies

  • Bootstrap
  • Font Awesome
  • AngularJS >= 1.2.x
  • Angular Sanitize

Installation

After you've downloaded this repository, include both the css and javascript file and then declare the notifications module as a dependency of your app module.

e.g angular.module('myApp', ['notifications'])

Once you've finished that business you should be able to use the notifications service. If you want those notifications to show up on the screen however (optional), you will need to add a div to your body tag somewhere and give it a notifications directive specifying its position like so:

<div notifications="bottom right"></div>

You should now magically get notifications!

Usage

In order to use the API you need to inject the $notification service into your controllers. From there you can use one of the many different notifications like:

  • info
  • warning
  • error
  • success

You can use these methods with the following line of code

$notification.info(title, content, userData, duration); $notification.warning(title, content, userData, duration); $notification.error(title, content, userData, duration); $notification.success(title, content, userData, duration);

Title is of course the title displayed in a large, bold text on the notification. The userData parameter is optional but allows you to store some data with a particular notification.

Duration is optional (milliseconds): It allows you to set hhow long the notification is shown. Put 0 or false if you want a persistent notification. If not given it take the value in the setting.

You can also use a generic notify method more inline with the standard chrome desktop notifications by specifying an image to display in the notification. $notification.notify('image.jpg', 'My Title', 'My notification description text');

HTML5 Notifications

If you want to use HTML5 notifications with the same API then you can call $notification.enableHtml5Mode().

Note: You will need permissions in order to use HTML5 notifications so for this reason you should call enableHtml5Mode in a click event listener or something.

Thanks to