10

I've researched other threads and am just confused.

Situation: I'm supplying a generic jQuery plugin that loads the div the user specifies dynamically via AJAX. Everything works fine, but on e.g. one user's page, there is a piece of JS that is not called, because the "ready" event is not refired.

The usual situation will be that the user's other jQuery stuff will be placed after jQuery(document).ready.

I've just tested calling:

$(document).trigger('ready');

manually - it has no effects at all, as I presume that "ready" is called only once and only once.

What is the proper way to handle it? (it would be great to provide the most generic solution possible)

I'd love to do something like suggested in this thread:

Trigger $document.ready (so AJAX code I can't modify is executed)

But I think that readyList is now private and can't be manipulated directly anymore?

It's worth mentioning, that the plugin I'm providing supplies a callback functionality for the user. Of course, (s)he could place post-loading handling JS code in there.

Thanks in advance and kind regards

Community
  • 1
  • 1
arvgta
  • 115
  • 1
  • 1
  • 8

2 Answers2

16

You shouldn't attempt to reload the entire DOM ready function. Particularly harmful is the n+n nature of events if you did, 2 click events on the same element for example could potentially become 4, then 8 etc. if the DOM ready function is repeatedly re-fired by them.

You can avoid this by taking out the code that you need to run once you're done with your ajax call and presumably the population of the element that you're hoping would benefit from the event you wish to re-initialise.

$(document).ready(function()
{
    initialise();

    //... Resume with DOM ready
});

function initialise()
{
    // create event here that needs re-initialising
}

So when you're done with your ajax call just call initialise() again.

Alternatively look to using .on and using it's bubbling up capabilities, this is how I would handle this kind of problem. It avoids you having to ever think about 're-initialising' any part of the DOM ready functions in your scripts.

Additional from comments

.on allows you to bind events to low level elements on the page that do not change at any time, whilst allowing you to control which of the dynamic elements actually trigger the event within that container.

<div id="container">

    <div id="ajax-content">

        <a href="#" class="created-link">A new link</a>

    </div>

</div>

So we know that the <a> is created by an ajax function after the DOM ready event is fired, therefore any direct events applied to it then would not work.

Instead we would bind the event to a lower level unchanged element and bubble up to the containing dynamic DOM element.

$('#container').on('click', '.created-link', function(event)
{
    event.preventDefault();

    // Your normal onclick code
});
Daut
  • 2,537
  • 1
  • 19
  • 32
David Barker
  • 14,484
  • 3
  • 48
  • 77
  • Hi David! Thanks very much! How could I use ".on()" to solve this, as that is what you would suggest, right? The variant with initialise() would require the user to re-tweak his libraries. Can that be avoided with the ".on()" approach? – arvgta Sep 02 '12 at 12:36
  • Solved with the initalise() approach in the callback for one use case by tweaking the library. Thanks very much for the update, David! – arvgta Sep 02 '12 at 13:40
  • No problem, and yes the first approach is obviously more disruptive but will serve its purpose to a point. Try to use .on when you can it will save you a whole load of headaches with spagetti code in the future. – David Barker Sep 02 '12 at 13:45
10

just to share my findings and solution, I had the same problem that after an AJAX reload the $(document).ready function is not called for this problem i have used combinations of this two answers, and in the end found a very simple solution

My solution looks like this

<script type="text/javascript">
function initialise(){
    $('.clickableItem').click(function(){
        /* do code here */
        return false;
    });
};
$(document).ready(function(){
    initialise();
});
$(document).ajaxComplete(function () {
    initialise();
});
</script>

hope this helps someone

Community
  • 1
  • 1
Matija Kraljic
  • 136
  • 1
  • 4