timurguseynov / flash

Package for displaying flash messages to the user

flash-messages-plus

Package for displaying flash messages to the user.

This package is a convergence of multiple influences:

• the chapter 'Creating a Meteorite Package' from the Discover Meteor Book
• foundation-flash-messages
• the original package from which this was forked
• this excellent flash package for Angular-JS

The default configuration for this package is designed for integration with Bootstrap Alerts CSS styles, so you will need to include Bootstrap for out-of-the-box functionality.

While it hasn't been explicitly tested, it should be possible to configure for integration with custom CSS or other CSS frameworks (e.g. Foundation).

You can see a demo of the original package and a modified version of the source code to work with this package.

##Default Usage

Include the template somewhere in your index.html file:

  {{> flash}}

And then send messages:

  Flash.alert(MESSAGE);
  Flash.error(MESSAGE);
  Flash.success(MESSAGE);
  Flash.info(MESSAGE);

To clear messages:

  Flash.clear();

Only the seen messages will be cleared.

###Named Flash Message Usage

The default usage should be sufficient for most use-cases, but it is possible to have "Named" flash messages for situations where multiple flash message areas are desired. This may be the case with complex layouts or when constructing packages with their own views containing flash messages.

The following configuration may be improved via the up and coming meteor-ui project, but for now, based on meteor circa 0.7.x the following may be used:

You can include the provided template either directly in an HTML file or in another template like so:

  {{> flash myFlashIdHelper}}

where myFlashIdHelper is a function which returns an object with an id property.

For use directly in HTML, this function must be registered via Handlebars.registerHelper() like so:

Handlebars.registerHelper('myFlashIdHelper', function() { return {id: 'myFlashId'} });

For use in another template, this function can be defined as a template helper like so:

Template.myTemplate.myFlashIdHelper = function() { return {id: 'myFlashId'} }

or using the alternative, helpers syntax:

Template.myTemplate.helpers = {
  myFlashIdHelper: function() { return {id: 'myFlashId'} },
  //...

And then send messages:

  Flash.alert(MESSAGE, {id: 'myFlashId'});
  Flash.error(MESSAGE, {id: 'myFlashId'});
  Flash.success(MESSAGE, {id: 'myFlashId'});
  Flash.info(MESSAGE, {id: 'myFlashId'});

##Configure

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

  Flash.configure({
    autoHide: true
    hideDelay: 5000
    activeClass: 'in'
    alertClass: 'alert'
    transitionClass: 'fade'
    successClasses: 'alert-success'
    infoClasses: 'alert-info'
    warningClasses: 'alert-warning'
    errorClasses: 'alert-error alert-danger'
    buttonClasses: 'close'
    transitionWait: 2000
  });

NOTE: The above code sample shows default values. The default CSS related options correspond to Bootstrap classes, but the implementation isn't tied to any particular CSS framework.

• autoHide: set to true to make flash message fade after hideDelay milliseconds, set to false to require the user to click the message to dismiss it.
• hideDelay: set the desired number of milliseconds for the flash message to be displayed (when autoHide is true)
• activeClass: class that will be automatically added and removed to effect the CSS transition (e.g. the Bootstrap in class)
• alertClass: class common to all alert styling (e.g. the Bootstrap alert class)
• transitionClass: class containing the transition to be activated via activeClass (e.g. the Bootstrap fade class)
• successClasses: classes to be used with success styling
• infoClasses: classes to be used with info styling
• warningClasses: classes to be used with warning styling
• errorClasses: classes to be used with error styling
• buttonClasses: classes to be used when autoHide is set to false and flash message has a dismiss button
• transitionWait: number of milliseconds to allow for the transition(s) activated by removing the activeClass

You can also set autoHide, hideDelay and id options on messages. This will override global configuration:

  Flash.alert(MESSAGE, { autoHide: false });
  Flash.error(MESSAGE, { hideDelay: 2000 });
  Flash.success(MESSAGE, { autoHide: true, hideDelay: 8000 });
  Flash.info(MESSAGE, {id: 'myFlashId');

###CSS Configuration for a fade transition

You can use the following CSS snippet to configure a fade effect based on the default styling depicted above which depends on the Bootstrap fade and in classes:

The value of transitionWait should be greater than or equal to the transition duration specified here:

.fade {
    opacity: 0;
    -webkit-transition: all 1s linear;
    transition: all 1s linear;
}