Current Version: v0.2
- Bootstrap
- AngularJS >= 1.2.x
After you've downloaded this repository, include both the CSS and JavaScript files and then declare the notifications module as a dependency of your app module, eg:
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
inside the page's body and give it the
notifications directive specifying its position like so:
<div notifications="bottom right"></div>
You should now magically get notifications!
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 how long the
notification is shown. Use 0
or false
if you want a persistent
notification. If no duration is specified, the default is used.
You can also use a generic notify method more in line 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');
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.
- @fetrarij : DerekRies#9
- @pablocaselas : DerekRies#7
- @deltapsilon : DerekRies#5
- @michaelwoods : https://github.com/valaky/angular-notifications/commit/2f05f7832f2af9e74b1fe68d55fe04aeabff52c7