Meteor Community Logo

Meteor Community

Packosphere

undefined's Avatar

juliancwirko:s-alert

v3.0.0•Published 9 years ago

This package has not had recent updates. Please investigate it's current state before committing to using it in your project.

Simple and fancy notifications for Meteor

sAlert Usage

Add package:

meteor add juliancwirko:s-alert

Optionally, add one or more effects:

meteor add juliancwirko:s-alert-scale
meteor add juliancwirko:s-alert-slide
meteor add juliancwirko:s-alert-genie
meteor add juliancwirko:s-alert-jelly
meteor add juliancwirko:s-alert-flip
meteor add juliancwirko:s-alert-bouncyflip
meteor add juliancwirko:s-alert-stackslide

Then place {{> sAlert}} in your main template. Recomended usage:

<body>
    {{> sAlert}}
</body>

sAlert configuration

sAlert can be configured on the client (more about possible configuration options below). The defaults are below:

1Meteor.startup(function () {
2
3    sAlert.config({
4        effect: '',
5        position: 'top-right',
6        timeout: 5000,
7        html: false,
8        onRouteClose: true,
9        stack: true,
10        offset: 0, // in px - will be added to first alert (bottom or top - depends of the position in config)
11        beep: false
12        // examples:
13        // beep: '/beep.mp3'  // or you can pass an object:
14        // beep: {
15        //     info: '/beep-info.mp3',
16        //     error: '/beep-error.mp3',
17        //     success: '/beep-success.mp3',
18        //     warning: '/beep-warning.mp3'
19        // }
20    });
21
22});

sAlert is based on a client-only collection. It is called sAlert.collection. Every sAlert method returns the ID of the alert it has just created.

1var warningThatWeWantToCloseLater = sAlert.warning('Please register', {timeout: 'none'});
2/* ... */
3sAlert.close(warningThatWeWantToCloseLater);

Fire up your alerts with these methods:

Error
sAlert.error('Your message', configOverwrite);
Warning
sAlert.warning('Your message', configOverwrite);
Info
sAlert.info('Your message', configOverwrite);
Success
sAlert.success('Your message', configOverwrite);
Close alert:
sAlert.close(alertId);
Immediately close all alerts:
sAlert.closeAll();

Individual alert configuration

And what is configOverwrite? This is an object with all the settings you want to override, on a per-alert basis. For example:

1sAlert.error('Boom! Something went wrong!', {effect: 'genie', position: 'bottom-right', timeout: 'none', onRouteClose: false, stack: false, offset: '80px'});

This particular error will be displayed in different way.

Available effects:

  • scale - meteor add juliancwirko:s-alert-scale
  • slide - meteor add juliancwirko:s-alert-slide
  • genie - meteor add juliancwirko:s-alert-genie
  • jelly - meteor add juliancwirko:s-alert-jelly
  • flip - meteor add juliancwirko:s-alert-flip
  • bouncyflip - meteor add juliancwirko:s-alert-bouncyflip
  • stackslide - meteor add juliancwirko:s-alert-stackslide

Available positions:

  • top-left
  • bottom-left
  • top-right
  • bottom-right
  • top (full width)
  • bottom (full width)

Timeout:

You can set up it in miliseconds or use the string none.

HTML tags

If you want you can use HTML in your message.

1sAlert.error('Boom! <br> Something went wrong!', {effect: 'your-effect-name-here', html: true});

You can also put it in the main sAlert config.

Closing alerts on route change

If you go to another route, in default the alerts should automatically be cleaned up. This works with Iron Router and FlowRouter. However if you want the alerts to persists on route change you should change onRouteClose param in your config (example above).

You can even overwrite it in sAlert methods calls. So you can close only some of the alerts on route change. Example:

1sAlert.warning('Opssss!!! No good! Keep me even when the route changes.', {onRouteClose: false, timeout: 10000});
2sAlert.info('Be careful and hide me when the route changes.', {onRouteClose: true, timeout: 10000});

Stacking alerts

By default your multiple alerts on the screen will appear one after another with shift on top or bottom. You can disable it by stack param. Just set it to false.

1sAlert.info('Opssss!!! I am full width alert without stacking enabled', {position: 'top'; stack: false});

You can also put it in the main sAlert config.

Alerts offset

If you want you can set up offset for your alerts. This is useful when you have for example some header and you want your alerts to appear below it. You can set this param in pixels. Default is '0';

1sAlert.info('Opssss!!! I am displayed below the header which is 70px height', {position: 'top'; offset: '100px'});

You can also put it in the main sAlert config.

Audio alerts

You can set up your audio 'beeps'. Just configure your audio file path (.mp3 is prefered because it should work in every browser). You can also configure 4 paths for 4 conditions. The best way is to put your audio files in public folde. Check the configuration above for more details.

There is no default audio sample in the package. You should use sound samples which you know that you have the right to use it.

CSS styling

You can override all CSS classes by targeting s-alert-{{alertType}}.s-alert-effect-{{effectType}}. The alert type classes are:

.s-alert-info, .s-alert-success, .s-alert-warning, .s-alert-error

For example, this CSS rule will override the style for .s-alert-error when displayed with the scale effect:

1.s-alert-error.s-alert-effect-scale {
2    background: #bada55;  /* your background color here */
3    color: #fff  /* your text color here */
4}

Your own effects packages

You can prepare your own effect package. As a reference, look at one of the ready-to-use packages, such as meteor-s-alert-jelly. You can create your own animations, but remember to use the .s-alert-effect-{your-effect-name-here} prefix. Then you can use it like:

1sAlert.error('Boom! Something went wrong!', {effect: 'your-effect-name-here'});

Or you can place it in the config:

1Meteor.startup(function () {
2
3    sAlert.config({
4        effect: 'your-effect-name-here',
5        position: 'top-right',
6        timeout: 5000
7    });
8
9});

If you want to have your effect package linked here just let me know.

Template overwriting

Here is a default template (it will be included when you use the standard {{> sAlert}}):

<div class="s-alert-box s-alert-{{condition}} s-alert-{{position}} s-alert-effect-{{effect}} s-alert-show" id="{{_id}}" style="{{boxPosition}}">
    <div class="s-alert-box-inner">
        <p>{{message}}</p>
    </div>
    <span class="s-alert-close"></span>
</div>

If you want to owerwrite it you should remember to be careful with all used helpers. They should remain in place. Here you have an example of overwriting an alert content template (Place it somewhere in your html files, you can name it as you want):

<template name="sAlertCustom">
    <div class="custom-alert-class s-alert-box s-alert-{{condition}} s-alert-{{position}} s-alert-effect-{{effect}} s-alert-show" id="{{_id}}" style="{{boxPosition}}">
        <div class="s-alert-box-inner">
            <div class="alert-header">
                <h1><i class="fa fa-{{sAlertIcon}}"></i> {{sAlertTitle}}</h1>
            </div>
            <div class="alert-content">
                <i class="fa fa-fw fa-cog"></i>
                {{message}}
            </div>
        </div>
        <span class="s-alert-close"></span>
    </div>
</template>

Usage of custom template

Place {{> sAlert template='sAlertCustom'}} in your main template.

Custom fields

As you can see in a custom sAlertCustom template we have used the sAlertTitle custom helper. Now if you want to pass the value to it you should call one of sAlert functions with the first parameter being an object instead of a message string:

1sAlert.info({sAlertIcon: 'asterisk', sAlertTitle: 'My custom sAlert field - the title', message: 'My sAlert message here'}, configOverwrite);

You can pass as many fields as you like. Remember to add the corresponding helpers in the template. configOverwrite works here the same as described above. It is of course optional.

Testing

Clone it into packages folder and run meteor with:

meteor test-packages --driver-package respondly:test-reporter juliancwirko:s-alert

and go to:

http://localhost:3000

Inspiration:

Thanks a lot for those who report bugs and request changes (especially @dandv). sAlert keeps getting better.

Also check out:

Note: Starting with version 3.0.0 old deprecated APIs are removed

Note: Starting with version 2.0.0 you should also choose and add and effect package. This is a more flexible and lean solution (previously, the effects CSS file contained all effect styles and it was heavy). sAlert will work without effects as well. You can add as many effect packages as you want. Config and usage are the same.

Changelog

v3.0.0

  • old API cleanup
  • Audio alerts

v2.4.2

  • Error object parse fix #29

v2.4.1

  • Router clearing option - Flow Router new triggers API adjustments

v2.4.0

  • stack param - enable/disable stacking feature
  • offset param - top or bottom offset of the first alert on screen. In pixels. Default '0'

v2.3.5

  • onRouteClose param - you can decide whether you want to close your alerts (or particular ones) when your route changes (default true)

v2.3.4

  • Some fixes related to template overwrite

v2.3.2, v2.3.3

  • Some tests added

v2.3.1

  • Iron Router clear fix

v2.3.0

  • displaying more than one alert (#7)

v2.2.0

  • now you can use HTML in your messages (thanks to @gibex)

v2.1.1

  • console info fix (#12)
  • sAlert init functions now returns alert id (#15)

v2.1.0

  • Postition names changed; example: 'right-bottom' is now 'bottom-right' etc. (The old names will work too, for backwards compatibility, but will be removed in v3.0.0.)
  • CSS class names changed; example: '.s-alert-blue' is now '.s-alert-info', coresponding to sAlert.info(...) etc.
  • two new positions: 'top' and 'bottom', for full-width alerts; they work for all effects
  • timeout 'no' is now 'none' ('no' is deprecated and will work but will be removed in v3.0.0)

v2.0.0

  • factor out effects into separate packages

License

MIT