flash-messages's Introduction

flash-messages

Package for displaying flash messages to the user. This is based on the chapter 'Creating a Meteorite Package' from the Discover Meteor Book and foundation-flash-messages package.

This package integrate well with Bootstrap Alerts styles, but Bootstrap is not a dependency.

You can see a demo and their source code.

##Note

The syntax has changed on version 0.2.0

##Usage

Include the template somewhere in your index.html file:

  {{> flashMessages}}

And then send messages:

  FlashMessages.sendWarning(MESSAGE);
  FlashMessages.sendError(MESSAGE);
  FlashMessages.sendSuccess(MESSAGE);
  FlashMessages.sendInfo(MESSAGE);

Note: sendAlert was deprecated, use sendWarning instead.

To clear messages:

  FlashMessages.clear();

Only the seen messages will be cleared.

##Configure

You can configure globally the way the messages behave with FlashMessages.configure (the below sample shows the default values):

  FlashMessages.configure({
    autoHide: true,
    hideDelay: 5000,
    autoScroll: true
  });

autoHide: set to true to make flash message fade after hideDelay milliseconds, set to false to require the user to click the close button on the message to dismiss it.
hideDelay: set the desired number of milliseconds for the flash message to be displayed (when autoHide is true).
autoScroll: set to true to enable auto scroll when a message is displayed, false to disable auto scroll. (Note: this can be set only globally.)

You can also set individual options on messages. This will override global configuration:

  FlashMessages.sendWarning(MESSAGE, { autoHide: false });
  FlashMessages.sendError(MESSAGE, { hideDelay: 2000 });
  FlashMessages.sendSuccess(MESSAGE, { autoHide: true, hideDelay: 8000 });

Recommend Projects