search

gfk-ba / meteor-notifications

Add reactive notifications to your meteor application
http://notifications-example.meteor.com/
MIT License
82 stars 21 forks source link

readme

Unit tests: Build Status

UI tests: Build Status

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

Installation

$ meteor add gfk:notifications

FAQ

How do I make the notifications stay in the top corner of the viewport?

If you want a notification to always be visible within the viewport of the browser even when the user scrolls, you should set the position of the notifications wrapper div to fixed.

Add the following CSS to your application:

ul.notifications {
position: fixed;
}

How do I push notification from server side?

You can use the server-messages package for that. The example page is setup for the usecase of notifications with this package source

First add gfk:server-messages to your application

meteor add gfk:server-messages

Then add the following code to your application:

Shared:

serverMessages = new ServerMessages();

Client:

  serverMessages.listen('serverMessage:info', function (subject, message, options) {
    Notifications.info(subject, message, options);
  });

  serverMessages.listen('serverMessage:warning', function (subject, message, options) {
    Notifications.warn(subject, message, options);
  });

  serverMessages.listen('serverMessage:success', function (subject, message, options) {
    Notifications.success(subject, message, options);
  });

  serverMessages.listen('serverMessage:error', function (subject, message, options) {
    Notifications.error(subject, message, options);
  });

Now you can push a notification to the server with the following code on the server:

serverMessages.notify('serverMessage:error', 'Error subject', 'Error message');

Contributing

All contributions are welcome! Please submit pull requests. Please add tests and make sure everything is green!

Testing

Unit tests

To run the unit tests execute the following command from within your checkout:

meteor test-packages ./

UI tests

To make my life and yours easier I've also created some basic UI tests for this project. They are stored in the meteor-notifications-example repository.

After each new version the example page is updated to use the latest version, after which travis runs the UI tests. But you can ofcourse also run them locally.

  1. Clone the example page repo
  2. From within your checkout run the following commands: 
    mkdir -p app/packages
ln -s #YourNotificationsPackageCheckoutDirectory# app/packages/gfk:notifications
  3. Make sure you have the example page running on port 3000
  4. From within the example page repo checkout run: ```nightwatch -c firefoxDev

The example page is also a good place to debug/check your new functionality. Consider adding a example of the new functionality and creating a PR for that too!

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:

Returns:

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

Wraps addNotification, sets type to error.

Params:

Returns:

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

Wraps addNotification, sets type to warning

Params:

Returns:

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

Wraps addNotification, sets type to info

Params:

Returns:

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

Wraps addNotification, sets type to success

Params:

Returns:

getNotificationClass(notificationType)

Gets the class containing the color for the notification

Params:

remove(selector)

Removes the notifications matching the mongo query selector

Params:

Example:

// Create Notification
var notificationId = Notifications.success('title', 'message');
// Remove exisiting notification sometime between [0,5) seconds
Meteor.setTimeout( function () {
    Notifications.remove({ _id: notificationId });
}, Math.Random() * 5000 );

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