Demo

Take a look at the simple demo that demonstrates some of the plugin's functionality

Updates

The current version is 0.2.5 (november 3th 2014)

• Major code improvements
• Added 'expand' animation (work in progress)
• Added 'positionType' parameter to allow for relative positioning within container other then body (which pushes contend down or up on show)
• Added parameter 'verticalMargin' to allow for margin at the top or bottom while using a fixed or absolute position
• Switched to the awsome Font Awsome for the icons. This allows for better quality scaling and for icon colors to be changed by parameters (work in progress)

Description

A jQuery plugin that allows you to create fully customisable notifications with very little effort. Multiple instances can be added to one page without conflicts. You can add a notifications directly to the body and on the same page create anonther instances in i.e. a div or any other DOM element for that matter. The plugin will automatically prepare the parent element to fit the needs for proper usage within that element.

The available public methods per instance are:

1. showError('error message')
2. showSuccess('success message')
3. showWarning('warning message')
4. close()

Event callback options are:

1. onClose
2. onShow

The configuration options are explained below.

Usage

1. Include plugin's css:

   <link rel="stylesheet" type="text/css" href="https://cdn.rawgit.com/sudo-systems/jquery-sudo-notify/master/dist/style/jquery.sudo-notify.min.css" />

2. Donwload the plugin, extract it and place the directory "dist/images/" in the root of your web application (or use the downloaded css file and modify the image paths).

3. Include jQuery:

   <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.11.1/jquery.min.js"></script>

4. Include plugin's code:

   <script type="text/javascript" src="https://cdn.rawgit.com/sudo-systems/jquery-sudo-notify/master/dist/jquery.sudo-notify.min.js"></script>

5. Add html element to the body:

   <div id="notificationContainer"></div>

6. Call the plugin (with default configuration):

   $(document).ready(function(){
     var sudoNotify = $('div#notificationContainer').sudoNotify();
   
     sudoNotify.success('Some success message');
     sudoNotify.warning('Some warning');
     sudoNotify.error('Some error');
     sudoNotify.close();
   });

7. OPTIONAL: Call plugin with custom configuration (all attributes are optional)

   $(document).ready(function(){
     var sudoNotify = $('div#notificationContainer').sudoNotify({
       autoHide: true,
       showCloseButton: true,
       duration: 6, //seconds
       position: 'top', //top or bottom
       positionType: 'absolute', //absolute, relative or fixed. Only applies if the elemnt's parent isn't the body. Otherwise it will always be fixed
       verticalMargin: '0px', //Doesn't work if positionType is 'relative'
       log: true,
       opacity: 0.95,
       defaultStyle: {
         maxWidth: '1200px',
         fontSize: '16px'
       },
       errorStyle: {
         color: '#000000',
         backgroundColor: '#FF9494'
       },
       warningStyle: {
         color: '#000000',
         backgroundColor: '#FFFF96'
       },
       successStyle: {
         color: '#000000',
         backgroundColor: '#B8FF6D'
       },
       animation: {
         type: 'slide-fade', //fade, scroll-left, scroll-left-fade, scroll-right, scroll-right-fade, slide, slide-fade or none, expand
         showSpeed: 400 ,
         hideSpeed: 250
       },
       onClose: function(notificationType) {
         alert(notificationType+ ' notification closed');
       },
       onShow: function(notificationType) {
         alert(notificationType+ ' notification showing');
       }
     }
   });

8. OPTIONAL: Or overwrite the default configuration before initiating the plugin (all attributes are optional)

   $.fn.sudoNotify.defaults = {
     autoHide: true,
     showCloseButton: true,
     duration: 6, //seconds
     position: 'top', //top or bottom
     positionType: 'absolute', //absolute, relative or fixed. Only applies if the elemnt's parent isn't the body. Otherwise it will always be fixed
     verticalMargin: '0px', //Doesn't work if positionType is 'relative'
     log: true,
     opacity: 0.95,
     defaultStyle: {
       maxWidth: '1200px',
       fontSize: '16px'
     },
     errorStyle: {
       color: '#000000',
       backgroundColor: '#FF9494'
     },
     warningStyle: {
       color: '#000000',
       backgroundColor: '#FFFF96'
     },
     successStyle: {
       color: '#000000',
       backgroundColor: '#B8FF6D'
     },
     animation: {
       type: 'slide-fade', //fade, scroll-left, scroll-left-fade, scroll-right, scroll-right-fade, slide, slide-fade or none, expand
       showSpeed: 400 ,
       hideSpeed: 250
     },
     onClose: function(notificationType) {
       alert(notificationType+ ' notification closed');
     },
     onShow: function(notificationType) {
       alert(notificationType+ ' notification showing');
     }
   };

TODO

1. Stop the scrollbars from appearing when a scroll or slide animation is in progress

License

BSD License © Bram van Oploo / Sudo Systems