Notify

Notifications appear on the rows, either the entire row or a column that you define. There is a notify property defined for each row object which allows multiple and simultanous use of notifications. The code below show examples. Use of notification is optional.

Update Notification

Updates existing notification or creates new one with the settings passed as arguments

• message : Message to be displayed, can be string or mithril m() template -- required
• type : Type setting that gives classes based on what you input here.
• column : Index of the column you want the notification to appear on, Falsy values use the entire row.
• timeout : When the notification should auto hide. Falsy values will keep it on
• css : Any additional classes you want to add to the view

    // tb = Treebeard object
    item.notify.update('Delete failed.', 'danger', undefined, 3000);

Toggle

Toggles visibility of the notifications.

    // tb = Treebeard object
       item.notify.toggle();

Show

Shows notification when message and other settings are already applied.

    // tb = Treebeard object
    if(showNotification){
       item.notify.show();
    }

Hide

Onyl removes the notification and brings the view back to normal.

    // tb = Treebeard object
    if(cancel){
       item.notify.hide();
    }

Self Destruct

Not only removes the notification but also deletes the row.

• treebeard : The treebeard object -required
• item : Item object - required
• timeout : When it should remove, default is 3000.

    // tb = Treebeard object
    if(uploadFail){
       item.notify.selfDestruct(tb, item, 2000)
    }

Treebeard Notification Code

    Notify = function _notify(message, type, column, timeout) {
        this.column = column || null;
        this.type = type || "info";
        this.message =  message || 'Hello';
        this.on = false;
        this.timeout = timeout === undefined ? DEFAULT_NOTIFY_TIMEOUT : timeout;
        this.css = '';
        this.toggle = function () {
            this.on = !this.on;
        };
        this.show = function () {
            this.on = true;
            var self = this;
            if (self.timeout && self.timeout > 1) {                     // set timeout to 1 to stay forever
                setTimeout(function () { self.hide(); }, self.timeout);
            }
            m.redraw(true);
        };
        this.hide = function () {
            this.on = false;
            m.redraw(true);
        };
        this.update = function(message, type, column, timeout, css) {
            this.type = type || this.type;
            this.column = column || this.column;
            this.timeout = timeout === undefined ? DEFAULT_NOTIFY_TIMEOUT : timeout;
            this.message = message;
            this.css = css || '';
            this.show(true);
        };
        this.selfDestruct = function (treebeard, item, timeout) {
            this.on = false;
            this.on = true;
            var self = this,
                out = timeout || 3000;
            setTimeout(function () { self.hide(); item.removeSelf(); treebeard.redraw(); }, out);
        };
    };