Skip to content

Add ability to set the notification duration and the persistence #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Add ability to set the notification duration and the persistence #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
190beb3
Add ability to set the notification duration and the persistence
fetrarij Jan 17, 2014
1675f96
Add the duration param in README.md
fetrarij Jan 17, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,15 @@ like:

You can use these methods with the following line of code

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

**Title** is of course the title displayed in a large, bold text on the notification.
**Content** is the additional detail text for that notification. The **userData** parameter
**Content** is the additional detail text for that notification.
**Duration** is optional (milliseconds): It allows you to set how 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 (5000).
The **userData** parameter
is optional but allows you to store some data with a particular notification.

You can also use a generic notify method more inline with the standard chrome desktop
Expand Down
109 changes: 58 additions & 51 deletions notification.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
'use strict';

angular.module('notifications', []).
factory('$notification', ['$timeout',function($timeout){
factory('$notification', ['$timeout',function($timeout) {

console.log('notification service online');
var notifications = JSON.parse(localStorage.getItem('$notifications')) || [],
Expand All @@ -20,16 +20,16 @@ angular.module('notifications', []).
html5DefaultIcon: 'icon.png'
};

function html5Notify(icon, title, content, ondisplay, onclose){
if(window.webkitNotifications.checkPermission() === 0){
if(!icon){
function html5Notify(icon, title, content, ondisplay, onclose) {
if (window.webkitNotifications.checkPermission() === 0) {
if (!icon) {
icon = 'favicon.ico';
}
var noti = window.webkitNotifications.createNotification(icon, title, content);
if(typeof ondisplay === 'function'){
if (typeof ondisplay === 'function') {
noti.ondisplay = ondisplay;
}
if(typeof onclose === 'function'){
if (typeof onclose === 'function') {
noti.onclose = onclose;
}
noti.show();
Expand All @@ -44,91 +44,91 @@ angular.module('notifications', []).

/* ========== SETTINGS RELATED METHODS =============*/

disableHtml5Mode: function(){
disableHtml5Mode: function() {
settings.html5Mode = false;
},

disableType: function(notificationType){
disableType: function(notificationType) {
settings[notificationType].enabled = false;
},

enableHtml5Mode: function(){
enableHtml5Mode: function() {
// settings.html5Mode = true;
settings.html5Mode = this.requestHtml5ModePermissions();
},

enableType: function(notificationType){
enableType: function(notificationType) {
settings[notificationType].enabled = true;
},

getSettings: function(){
getSettings: function() {
return settings;
},

toggleType: function(notificationType){
toggleType: function(notificationType) {
settings[notificationType].enabled = !settings[notificationType].enabled;
},

toggleHtml5Mode: function(){
toggleHtml5Mode: function() {
settings.html5Mode = !settings.html5Mode;
},

requestHtml5ModePermissions: function(){
if (window.webkitNotifications){
console.log('notifications are available');
requestHtml5ModePermissions: function() {
if (window.webkitNotifications) {
//console.log('notifications are available');
if (window.webkitNotifications.checkPermission() === 0) {
return true;
}
else{
window.webkitNotifications.requestPermission(function(){
if(window.webkitNotifications.checkPermission() === 0){
window.webkitNotifications.requestPermission(function() {
if (window.webkitNotifications.checkPermission() === 0) {
settings.html5Mode = true;
}
else{
else {
settings.html5Mode = false;
}
});
return false;
}
}
else{
console.log('notifications are not supported');
else {
//console.log('notifications are not supported');
return false;
}
},


/* ============ QUERYING RELATED METHODS ============*/

getAll: function(){
getAll: function() {
// Returns all notifications that are currently stored
return notifications;
},

getQueue: function(){
getQueue: function() {
return queue;
},

/* ============== NOTIFICATION METHODS ==============*/

info: function(title, content, userData){
console.log(title, content);
return this.awesomeNotify('info','info', title, content, userData);
info: function(title, content, duration, userData) {
//console.log(title, content);
return this.awesomeNotify('info','info', title, content, duration, userData);
},

error: function(title, content, userData){
return this.awesomeNotify('error', 'remove', title, content, userData);
error: function(title, content, duration, userData) {
return this.awesomeNotify('error', 'times-circle', title, content, duration, userData);
},

success: function(title, content, userData){
return this.awesomeNotify('success', 'ok', title, content, userData);
success: function(title, content, duration, userData) {
return this.awesomeNotify('success', 'check', title, content, duration, userData);
},

warning: function(title, content, userData){
return this.awesomeNotify('warning', 'exclamation', title, content, userData);
warning: function(title, content, duration, userData) {
return this.awesomeNotify('warning', 'exclamation', title, content, duration, userData);
},

awesomeNotify: function(type, icon, title, content, userData){
awesomeNotify: function(type, icon, title, content, duration, userData) {
/**
* Supposed to wrap the makeNotification method for drawing icons using font-awesome
* rather than an image.
Expand All @@ -139,16 +139,16 @@ angular.module('notifications', []).
* through classes.
*/
// image = '<i class="icon-' + image + '"></i>';
return this.makeNotification(type, false, icon, title, content, userData);
return this.makeNotification(type, false, icon, title, content, duration, userData);
},

notify: function(image, title, content, userData){
notify: function(image, title, content, duration, userData) {
// Wraps the makeNotification method for displaying notifications with images
// rather than icons
return this.makeNotification('custom', image, true, title, content, userData);
return this.makeNotification('custom', image, true, title, content, duration, userData);
},

makeNotification: function(type, image, icon, title, content, userData){
makeNotification: function(type, image, icon, title, content, duration, userData) {
var notification = {
'type': type,
'image': image,
Expand All @@ -160,18 +160,25 @@ angular.module('notifications', []).
};
notifications.push(notification);

if(settings.html5Mode){
html5Notify(image, title, content, function(){
if (duration == undefined) {
var duration = settings[type].duration;
}

if (settings.html5Mode) {
html5Notify(image, title, content, function() {
console.log("inner on display function");
}, function(){
}, function() {
console.log("inner on close function");
});
}
else{
else {
queue.push(notification);
$timeout(function removeFromQueueTimeout(){
queue.splice(queue.indexOf(notification), 1);
}, settings[type].duration);

if (duration) {
$timeout(function removeFromQueueTimeout() {
queue.splice(queue.indexOf(notification), 1);
}, duration);
}

}

Expand All @@ -182,27 +189,27 @@ angular.module('notifications', []).

/* ============ PERSISTENCE METHODS ============ */

save: function(){
save: function() {
// Save all the notifications into localStorage
// console.log(JSON);
if(settings.localStorage){
if (settings.localStorage) {
localStorage.setItem('$notifications', JSON.stringify(notifications));
}
// console.log(localStorage.getItem('$notifications'));
},

restore: function(){
restore: function() {
// Load all notifications from localStorage
},

clear: function(){
clear: function() {
notifications = [];
this.save();
}

};
}]).
directive('notifications', ['$notification', '$compile', function($notification, $compile){
directive('notifications', ['$notification', '$compile', function($notification, $compile) {
/**
*
* It should also parse the arguments passed to it that specify
Expand Down Expand Up @@ -246,10 +253,10 @@ angular.module('notifications', []).
scope: {},
template: html,
link: link,
controller: ['$scope', function NotificationsCtrl( $scope ){
controller: ['$scope', function NotificationsCtrl( $scope ) {
$scope.queue = $notification.getQueue();

$scope.removeNotification = function(noti){
$scope.removeNotification = function(noti) {
$scope.queue.splice($scope.queue.indexOf(noti), 1);
};
}
Expand Down