system_messages.js

Go to the documentation of this file.

define(['jquery', 'elgg'], function ($, elgg) {

    // hide the current messages
    $('.elgg-system-messages .elgg-message').each(function () {
        var $message = $(this);
        
        var delay = $message.data().ttl;
        if (delay === 0) {
            // 0 means an explicit persistent message
            return;
        }
        
        if (!delay && !$message.hasClass('elgg-message-error')) {
            delay = elgg.config.message_delay;
        }
        
        if (!delay) {
            return;
        }
        
        var $list_item = $message.parent();
        $list_item.animate({opacity: '1.0'}, delay).fadeOut('slow');
    });

    // if the user clicks the before pseudo selector of a system message, make it disappear
    $(document).on('click', '.elgg-system-messages .elgg-message', function(e) {
        var $this = $(this);

        // slideUp allows dismissals without notices shifting around unpredictably
        $this.clearQueue().slideUp(100, function () {
            $this.remove();
        });
    });
    
    $(document).on('click', '.elgg-system-messages .elgg-message .elgg-inner', function(e) {
        // prevent clicks from bubbling to top so 'closing' a message only works with before pseudo selector content
        e.stopImmediatePropagation();
    });
    
    function showMessage(msgs, delay, type) {
        if (msgs === undefined) {
            return;
        }
        
        //Handle non-arrays
        if (!Array.isArray(msgs)) {
            msgs = [msgs];
        }
        
        var classes = ['elgg-message'];
        if (type) {
            classes.push('elgg-message-' + type);
        }
        
        // validate delay. Must be a positive integer.
        delay = (typeof delay === 'string') ? parseInt(delay, 10) : delay;
        if (isNaN(delay) || delay < 0) {
            delay = 0;
        }
        
        var messages_html = [];
        msgs.forEach(function(msg) {
            messages_html.push('<li><div class="' + classes.join(' ') + '"><div class="elgg-inner"><div class="elgg-body">' + msg + '</div></div></div></li>');
        });
        
        var $new_messages = $(messages_html.join('')).appendTo($('ul.elgg-system-messages'));
        if (delay > 0) {
            $new_messages.animate({opacity: '1.0'}, delay).fadeOut('slow')
        }
    };

    return {
        clear: function () {
            $('ul.elgg-system-messages').empty();
        },
        
        success: function (message, delay) {
            delay = parseInt(delay || elgg.config.message_delay, 10);
            
            showMessage(message, delay, 'success');
        },
        
        error: function (message, delay) {
            showMessage(message, delay, 'error');
        }
    };
});