Unit tests:

UI tests:

Meteor notifications

Add tooltip-style reactive notifications to your Meteor application. Makes use of Meteor's rendering system; not just a jQuery/bootstrap wrapper.

See example page @ meteor.com source: github.com

Versions

|Meteor Version|Notifications version| | ------------- |:-------------:| -----:| |Meteor 0.8.2+ (Blaze 0.2)|v0.5.0 and above| |Meteor 0.8.0+ (Blaze 0.1)|v0.4.5 and above in v0.4.*| |Meteor 0.7.0+ (Spark)|v0.4.4 and below|

Note: v1.0.0 & v1.0.1 was only published to troposphere(Meteor's own package server). v1.0.2 Are published on both troposphere & atmosphere

Note: untested on versions before 0.7.0

Installation

Meteor 0.9.0 and above:

$ meteor add gfk:notifications

Meteor 0.8 and below - use Meteorite:

$ mrt add notifications

API

Basics

To create a notification

First add the following to the template you want to be the parent for your notifications.

{{> notifications}}

Then run the following code in your application to spawn a notification of the type of the method you use to spawn it:

Notifications.warn('title', 'message');
Notifications.error('title', 'message');
Notifications.info('title', 'message');
Notifications.success('title', 'message');

Changing default settings

To change the animation speed or the hideAnimationProperties, you need to change the Notifications.settings object.

Example:

Meteor.startup(function () {
    Notifications.settings.animationSpeed = 500;
});

Default options to be used for each notification can be changed in the Notifications.defaultOptions object.

Example:

Meteor.startup(function () {
    _.extend(Notifications.defaultOptions, {
        timeout: 5000
    });
});

Optionally, you can also provide type-specific options by changing the Notifications.defaultOptionsByType object.

Meteor.startup(function () {
    //Give Error notifications a longer timeout
    Notifications.defaultOptionsByType[Notifications.TYPES.ERROR] = _.defaults({
        timeout: 10000
    },
    Notifications.defaultOptions);
});

Restyling the notifications

To restyle the notifications check the styleSheet and create your own stylesheet that overrides the classes defined in the bundled style. For instance, if you want to make the success notifications red you would add the following:

li.notification {
    &.success {
        background-color: #F00;
    }
}

Notifications()

Creates an instance of Notifications.

addNotification(title, message, [options={}])

Adds a notification.

Params:

• String title of the notification
• String message of the notification
• Object [options={}] Options object to use for notification
• String [options.type=defaultOptions.type] the type of the notification
• Boolean [options.userCloseable=defaultOptions.userCloseable] Whether the notification is user closeable
• Boolean [options.clickBodyToClose=defaultOptions.clickBodyToClose] Whether the notification can be closed by clicking anywhere in the body. If turned off then the user must click the close button.
• Number [options.timeout=defaultOptions.timeout] No. of milliseconds after which this notification should automatically be closed. Use 0 to disable this.
• Function [options.closed] Call this handler (passing data context) on notification close

error(title, message, [options={}])

Wraps addNotification, sets type to error.

Params:

• String title of the notification
• String message of the notification
• Object [options={}] Options object to use for notification
• Boolean [options.userCloseable=defaultOptions.userCloseable] Whether the notification is user closeable
• Boolean [options.clickBodyToClose=defaultOptions.clickBodyToClose] Whether the notification can be closed by clicking anywhere in the body. If turned off then the user must click the close button.
• Number [options.timeout=defaultOptions.timeout] No. of milliseconds after which this notification should automatically be closed. Use 0 to disable this.
• Function [options.closed] Call this handler (passing data context) on notification close

warn(title, message, [options={}])

Wraps addNotification, sets type to warning

Params:

• String title of the notification
• String message of the notification
• Object [options={}] Options object to use for notification
• Boolean [options.userCloseable=defaultOptions.userCloseable] Whether the notification is user closeable
• Boolean [options.clickBodyToClose=defaultOptions.clickBodyToClose] Whether the notification can be closed by clicking anywhere in the body. If turned off then the user must click the close button.
• Number [options.timeout=defaultOptions.timeout] No. of milliseconds after which this notification should automatically be closed. Use 0 to disable this.
• Function [options.closed] Call this handler (passing data context) on notification close

info(title, message, [options={}])

Wraps addNotification, sets type to info

Params:

• String title of the notification
• String message of the notification
• Object [options={}] Options object to use for notification
• Boolean [options.userCloseable=defaultOptions.userCloseable] Whether the notification is user closeable
• Boolean [options.clickBodyToClose=defaultOptions.clickBodyToClose] Whether the notification can be closed by clicking anywhere in the body. If turned off then the user must click the close button.
• Number [options.timeout=defaultOptions.timeout] No. of milliseconds after which this notification should automatically be closed. Use 0 to disable this.
• Function [options.closed] Call this handler (passing data context) on notification close

success(title, message, [options={}])

Wraps addNotification, sets type to success

Params:

• String title of the notification
• String message of the notification
• Object [options={}] Options object to use for notification
• Boolean [options.userCloseable=defaultOptions.userCloseable] Whether the notification is user closeable
• Boolean [options.clickBodyToClose=defaultOptions.clickBodyToClose] Whether the notification can be closed by clicking anywhere in the body. If turned off then the user must click the close button.
• Number [options.timeout=defaultOptions.timeout] No. of milliseconds after which this notification should automatically be closed. Use 0 to disable this.
• Function [options.closed] Call this handler (passing data context) on notification close

getNotificationClass(notificationType)

Gets the class containing the color for the notification

Params:

• String notificationType

remove()

Removes the notifications matching the selector

Params:

• selector **

TYPES

Stores constants for the different notification types

defaultOptions

Object with the default options for the notifications

defaultOptionsByType

Object with the default options for the notifications for specific types