angular-growl-notifications
v2.6.0
Published
Downloads
3,527
Maintainers
jvandemoReadme
Growl notifications for AngularJS
Notifications logically belong inside the view layer of your application.
Most existing growl systems require you to add notifications using JavaScript inside your controller layer.
This very lightweight library (<2KB) allows you to declaratively create notifications using directives only, supporting both inline expressions and HTML.
Think Growl, but in AngularJS directives. Oh, and Bootstrap compatible too.
Quick start
Learn how to create Mac OS X like pop-up notifications in your AngularJS application.
STEP 1: Install the library
Download the code from GitHub or install it using bower:
$ bower install angular-growl-notificationsLoad the library in your markup:
<script type="text/javascript" src="angular.js"></script>
<script type="text/javascript" src="angular-growl-notifications.js"></script>Load the growlNotifications module in your AngularJS application:
angular.module('yourApp', ['growlNotifications']);The library is now loaded in your AngularJS application.
STEP 2: Specify where you want to render the notifications
Before you can create notifications, you need to add the growl-notifications (plural) directive to your markup.
This directive allows you to control where the notifications are rendered in your DOM in case your application requires special behavior.
In most cases you should simply add it as the first element inside the body element:
<body>
<growl-notifications></growl-notifications>
...
</body>Check out the growl-notifications directive documentation for more information.
STEP 3: Create notifications
You can now use the growl-notification (singular) directive to create notifications anywhere in your application:
<!-- This notification will be shown when the page loads -->
<growl-notification>
Hello world
</growl-notification>You can use AngularJS expressions:
<!-- This notification will be shown when the page loads -->
<growl-notification>
Hello {{name}}
</growl-notification>and HTML:
<!-- This notification will be shown when the page loads -->
<growl-notification>
Hello <strong>{{name}}</strong>
</growl-notification>Most of the time you will want to show a notification when some event occurs. You can use the native AngularJS ng-if directive to make this happen:
<!-- This notification will be shown when showNotification becomes truthy -->
<growl-notification ng-if="showNotification">
showNotification just became truthy
</growl-notification>By default notifications are shown for 5 seconds, but you can specify the ttl in milliseconds for every notification individually:
<growl-notification ttl="1000">
Only show me for 1000ms
</growl-notification>A ttl of -1 or false will disable the automatic closing timeout, making the notification permanent. You will need to close the notification manually using $growlNotification.remove().
You can also specify handlers you wish to run when the notification opens and closes:
<growl-notification on-open="doSomething()" on-close="doSomethingElse()">
...
</growl-notification>which is convenient if you want to auto-reset some state when the notification is closed:
<button ng-click="showNotification = true">Show notification</button>
<!-- reset showNotification to false again when notification is closed -->
<!-- so the ng-if is triggered every time the button is clicked -->
<growl-notification ng-if="showNotification" on-close="showNotification = false">
...
</growl-notification>Check out the growl-notification directive documentation for all available options.
STEP 4: Customize look and feel
By default no styling is applied so you can completely control the look and feel of the notifications in your application's stylesheet.
The possibilities are endless, for example to display notifications in the top right of your page:
growl-notifications{
position: fixed;
top: 150px;
right: 10px;
}
growl-notification{
border: 1px solid black;
padding: 15px 30px;
margin-bottom: 15px;
}That's it
You now have a working notification system in your AngularJS application.
When you load the page, a "Hello world" notification will automatically appear and disappear.
There are many additional features and options, so make sure to visit the examples page for more inspiration and sample code.
Manually closing notification after a UI-Router state change
If you find yourself in a rare situation where you need to manually close a notification after a state change, you can create a custom directive as demonstrated in this plunk and discussed in this thread.
License
MIT
Change log
v2.5.1
- Added support for permanent notifications. Setting
ttlto-1orfalsewill keep notifications visible until manually closed (e.g with$growlNotification.remove());
v2.6.0
- Add support for infinite notification (#31)
v2.5.0
- Replace $timeout with $interval to fix #28
v2.4.0
- Updated timeout cancel mechanism (#27)
v2.3.0
- Updated angular dependency version (#22)
v2.2.0
- Added support for
on-openhandler - Added support for
on-closehandler - Updated documentation
v2.1.2
- Make angular dependency version less strict
v2.1.1
- Fix issue with injection of
$animatein controller ofgrowlNotificationdirective
v2.1.0
- Update code to follow the AngularJS styleguide principles
v2.0.1
- Fix issue with minification of controller in
growlNotificationdirective (see this issue).
v2.0.0
- Directives have been rewritten for better performance
- Now supports manually closing notifications using markup
- v1 release has been moved to v1.x.x branch
v0.7.0
- Added support for custom css prefix (defaults to Bootstrap alert)
v0.6.0
- The growl-notifications directive now uses an isolate scope
v0.5.0
- Added support for custom options in growl-notification directive
- Updated demo page
v0.4.0
- Added $animate support
- Updated demo page
v0.3.0
- Added dist directory with pre-built library files
- Added demo page
v0.2.0
- Added
growl-notificationdirective to conveniently add notifications from within HTML markup - Added
growl-notificationsdirective to conveniently display notifications from within HTML markup - Added documentation
v0.1.0
- Initial version