MartinL83 / Meteor-Notify

Notification boilerplate for Meteor

Meteor-Notify

A simple notification boilerplate for [Meteor] (https://github.com/meteor/meteor). Using Meteor´s functionality.

MIT License Copyright (c) 2016 Martin Lindgren

Usage

In notify.js a new constructor is made called "Notify". Simply import notify.js anywhere in your project and you are (almost) ready to go.

Step 1 Create a notification.

Notify.add({
  title: 'My title',
  message: 'A message'
});

This will add a new notification to the local notifications collection. By default it will expire in 2000 milliseconds. When it expires it will automaticly get deleted from the collection.

Notify will always return the _id of the notification. So if you want to remove the notification yourself you can set expireAt to 0, and remove the notification later.

var message = {
  title: 'A title',
  message: 'My message,
  expireAt: 0
};

// Add the notification, will return _id
var notification = Notify.add(message);

// Later on, remove the notification using the returned _id.
Notify.remove(notification);

Step 2 You will need to roll your own template code. This depends on the template engine you are using. For example in Blaze:

Template.Notify_Wrapper.helpers({
  notifications: function(){
    return Notify.notifications.find();
  }
});

Then in your HTML

<template name="Notify_Wrapper">
  {{#if notifications}}
  <div id="notifications">
    {{#each notifications}}
        {{> Notification}}
    {{/each}}
  </div>
  {{/if}}
</template>

<template name="Notification">
  <div class="notification notification-{{type}}" id="notification-{{_id}}">
    {{#if title}}
      <strong>{{title}} </strong>
    {{/if}}
    {{#if message}}
      <span>{{message}}</span>
    {{/if}}
  </div>
</template>

Step 3

You will also have to roll your own CSS styles.