Have Bootstrap plugin events forward the underlying originalEvent that caused them

[cookch10]

It would be useful to know if an expand / collapse event was triggered by a user interaction (e.g. a click) or something else (e.g. programmatically) without having to bind a new click event handler.

Given the following code (which is based off of bootstrap v3.2.0):

/*  Feature request:  Forward the originalEvent to (panel / accordion) collapse API handler(s)
 *
 *  In line 646 of bootstrap 3.2.0, the following click event handler is constructed:
 *
 *  $(document).on('click.bs.collapse.data-api', '[data-toggle="collapse"]', function (e) {...}
 *
 *  It would be useful to know if expand / collapse was triggered by a user interaction (e.g. a click) or
 *  something else (e.g. programmatically) without having to bind a new click event handler.
 *
 *  This could be accomplished by capturing the e.originalEvent in the event handler described above.
 */

var $collapseElements = $('.collapse'),
    fnCollapseCallback = function (e) {
        // if this event was triggered by something other than a desired user interaction, do nothing.

        var originalEvent = e.originalEvent || {};

        if (originalEvent.type === 'click') {
            // do something useful, like fire analytics tracking
        }
    };

$collapseElements.on({
    'hide.bs.collapse': fnCollapseCallback,
    'shown.bs.collapse': fnCollapseCallback
});


$collapseElements.collapse(); // programmatic collapse (not generated from a user interaction), do not want to track this.

In the example above I have indicated capturing the e.originalEvent object and storing it on the event object supplied to the fnCollapseCallback handler.

It might be the case that there is an existing attribute more suited for storing this information (and possibly also not storing the entire originalEvent object).

[peterblazejewicz]

@cookch10

$collapseElements.collapse(); // programmatic collapse (not generated from a user interaction), do not want to track this.

if (originalEvent.type === 'click') {
     // do something useful, like fire analytics tracking
}

The Collapse does not consume/prevent event bubbling - why not use .e.g data-attributes with other code to integrate with analytics? (I've been using GA tracking via data attributes on the past gig). See e.g.: http://bit.ly/1x7Cft7 and other.

$(document).on('click.analytics.data-api', '[data-whateverfits="ga"]', function (e) {

[cookch10]

@peterblazejewicz The point of my suggestion is to not create additional event handlers.

Also, in my specific use case I am actually tracking collapse / expand with regard to panels.

[cvrebert]

Sounds like a reasonable & useful request to me.

[peterblazejewicz]

Can then @cookch10's request be expanded to other related UI components? I've used to write a code/markup to track many actions on the important, user facing elements like Alerts and Modals - so just like with Collapse it would be useful to get original event (otherwise I have to resort to additional event bindings). Thanks!

[cvrebert]

Punting this to v4. Added it to our v4 todo list.

[cookch10]

Nice!