Detectar alterações no DOM


242

Eu quero executar uma função quando alguma div ou entrada são adicionadas ao html. Isso é possível?

Por exemplo, uma entrada de texto é adicionada e a função deve ser chamada.


1
A menos que algum script de terceiros esteja adicionando os nós ao DOM, isso não é necessário.
Justin Johnson



4
@JustinJohnson Se você estiver fazendo uma extensão do Chrome que injeta código JS, é útil.
FluorescentGreen5 /

Respostas:


206

Atualização de 2015, o novo MutationObserveré suportado por navegadores modernos:

Chrome 18+, Firefox 14+, IE 11+, Safari 6+

Se precisar dar suporte aos mais antigos, tente recorrer a outras abordagens, como as mencionadas nesta resposta de 5 (!) Anos abaixo. Existem dragões. Aproveitar :)


Alguém mais está mudando o documento? Porque se você tiver controle total sobre as alterações, precisará criar sua própria domChangedAPI - com uma função ou evento personalizado - e acioná-la / chamá-la em qualquer lugar que modificar as coisas.

O DOM Nível 2 tem tipos de eventos de Mutação , mas a versão mais antiga do IE não é compatível. Observe que os eventos de mutação foram preteridos na especificação de Eventos DOM3 e têm uma penalidade de desempenho .

Você pode tentar emular um evento de mutação onpropertychangeno IE (e voltar à abordagem de força bruta, se nenhum deles estiver disponível).

Para um domínio completo, um intervalo pode ser uma substituição excessiva. Imagine que você precisa armazenar o estado atual de todo o documento e examinar cada propriedade de cada elemento para ser a mesma.

Talvez se você estiver interessado apenas nos elementos e na ordem deles (como você mencionou na sua pergunta), um getElementsByTagName("*")pode funcionar. Isso será acionado automaticamente se você adicionar um elemento, remover um elemento, substituir elementos ou alterar a estrutura do documento.

Eu escrevi uma prova de conceito:

(function (window) {
    var last = +new Date();
    var delay = 100; // default delay

    // Manage event queue
    var stack = [];

    function callback() {
        var now = +new Date();
        if (now - last > delay) {
            for (var i = 0; i < stack.length; i++) {
                stack[i]();
            }
            last = now;
        }
    }

    // Public interface
    var onDomChange = function (fn, newdelay) {
        if (newdelay) delay = newdelay;
        stack.push(fn);
    };

    // Naive approach for compatibility
    function naive() {

        var last = document.getElementsByTagName('*');
        var lastlen = last.length;
        var timer = setTimeout(function check() {

            // get current state of the document
            var current = document.getElementsByTagName('*');
            var len = current.length;

            // if the length is different
            // it's fairly obvious
            if (len != lastlen) {
                // just make sure the loop finishes early
                last = [];
            }

            // go check every element in order
            for (var i = 0; i < len; i++) {
                if (current[i] !== last[i]) {
                    callback();
                    last = current;
                    lastlen = len;
                    break;
                }
            }

            // over, and over, and over again
            setTimeout(check, delay);

        }, delay);
    }

    //
    //  Check for mutation events support
    //

    var support = {};

    var el = document.documentElement;
    var remain = 3;

    // callback for the tests
    function decide() {
        if (support.DOMNodeInserted) {
            window.addEventListener("DOMContentLoaded", function () {
                if (support.DOMSubtreeModified) { // for FF 3+, Chrome
                    el.addEventListener('DOMSubtreeModified', callback, false);
                } else { // for FF 2, Safari, Opera 9.6+
                    el.addEventListener('DOMNodeInserted', callback, false);
                    el.addEventListener('DOMNodeRemoved', callback, false);
                }
            }, false);
        } else if (document.onpropertychange) { // for IE 5.5+
            document.onpropertychange = callback;
        } else { // fallback
            naive();
        }
    }

    // checks a particular event
    function test(event) {
        el.addEventListener(event, function fn() {
            support[event] = true;
            el.removeEventListener(event, fn, false);
            if (--remain === 0) decide();
        }, false);
    }

    // attach test events
    if (window.addEventListener) {
        test('DOMSubtreeModified');
        test('DOMNodeInserted');
        test('DOMNodeRemoved');
    } else {
        decide();
    }

    // do the dummy test
    var dummy = document.createElement("div");
    el.appendChild(dummy);
    el.removeChild(dummy);

    // expose
    window.onDomChange = onDomChange;
})(window);

Uso:

onDomChange(function(){ 
    alert("The Times They Are a-Changin'");
});

Funciona no IE 5.5+, FF 2+, Chrome, Safari 3+ e Opera 9.6+


4
Pensando: como o jQuery live () resolve esse problema se eles não conseguem detectar uma alteração no DOM?
precisa saber é o seguinte

162
Não acredito que em 2010 você tinha o IE5.5 para testar isso.
Oscar Godson

1
@ JoshStodola O negrito também estava me irritando. Eu decidi consertar isso.
Bojangles

1
Os eventos de mutações foram preteridos. Você deve usar MutationObserver. Eu escrevi o meu plugin para problemas como este - github.com/AdamPietrasiak/jquery.initialize
pie6k

1
Como faço para que o jquery onClick seja acionado antes de um observador de mutação, que é acionado quando um botão é clicado com uma ação de brasa? stackoverflow.com/questions/29216434/...
SuperUberDuper

219

Esta é a melhor abordagem até agora, com o menor código:

IE9 +, FF, Webkit:

Usando MutationObserver e retornando aos eventos de Mutação descontinuados , se necessário:
(exemplo abaixo, se apenas para alterações no DOM relativas a nós anexados ou removidos)

var observeDOM = (function(){
  var MutationObserver = window.MutationObserver || window.WebKitMutationObserver;

  return function( obj, callback ){
    if( !obj || !obj.nodeType === 1 ) return; // validation

    if( MutationObserver ){
      // define a new observer
      var obs = new MutationObserver(function(mutations, observer){
          callback(mutations);
      })
      // have the observer observe foo for changes in children
      obs.observe( obj, { childList:true, subtree:true });
    }
    
    else if( window.addEventListener ){
      obj.addEventListener('DOMNodeInserted', callback, false);
      obj.addEventListener('DOMNodeRemoved', callback, false);
    }
  }
})();

//------------< DEMO BELOW >----------------
// add item
var itemHTML = "<li><button>list item (click to delete)</button></li>",
    listElm = document.querySelector('ol');

document.querySelector('body > button').onclick = function(e){
  listElm.insertAdjacentHTML("beforeend", itemHTML);
}

// delete item
listElm.onclick = function(e){
  if( e.target.nodeName == "BUTTON" )
    e.target.parentNode.parentNode.removeChild(e.target.parentNode);
}
    
// Observe a specific DOM element:
observeDOM( listElm, function(m){ 
   var addedNodes = [], removedNodes = [];

   m.forEach(record => record.addedNodes.length & addedNodes.push(...record.addedNodes))
   
   m.forEach(record => record.removedNodes.length & removedNodes.push(...record.removedNodes))

  console.clear();
  console.log('Added:', addedNodes, 'Removed:', removedNodes);
});


// Insert 3 DOM nodes at once after 3 seconds
setTimeout(function(){
   listElm.removeChild(listElm.lastElementChild);
   listElm.insertAdjacentHTML("beforeend", Array(4).join(itemHTML));
}, 3000);
<button>Add Item</button>
<ol>
  <li><button>list item (click to delete)</button></li>
  <li><button>list item (click to delete)</button></li>
  <li><button>list item (click to delete)</button></li>
  <li><button>list item (click to delete)</button></li>
  <li><em>&hellip;More will be added after 3 seconds&hellip;</em></li>
</ol>


1
parece funcionar muito bem para novos nós DOM. Podemos adaptá-lo a lidar também mudanças nó DOM (pelo menos a valores de nó DOM / texto?)
Sebastien Lorber

8
@SebastienLorber - quem é "nós"? você, como programador, pode pegar esse código e usá-lo como desejar. basta ler no MDN para quais coisas você pode observar o DOM e quais não pode.
vsync

2
Passe os mutations, observerparâmetros para a função de retorno de chamada para obter mais controle.
A1rPun

2
Isso me ajudou muito, mas como faço para "desvincular" isso? Digamos que desejo observar uma alteração apenas uma vez, mas faça isso em várias ocasiões? oberserveDOM = null, obviamente, não vai funcionar ...
stiller_leser

Por que isso funcionaria apenas para anexado / removido? Parece que a mutação eventos cobrir mais do que isso .. developer.mozilla.org/en-US/docs/Web/Guide/Events/...
f0ster

15

Eu escrevi recentemente um plugin que faz exatamente isso - jquery.initialize

Você usa da mesma maneira que a .eachfunção

$(".some-element").initialize( function(){
    $(this).css("color", "blue"); 
});

A diferença de .eaché - ele pega seu seletor, nesse caso, .some-elemente aguarda novos elementos com esse seletor no futuro; se esse elemento for adicionado, ele também será inicializado.

No nosso caso, a função de inicialização apenas altera a cor do elemento para azul. Portanto, se adicionarmos um novo elemento (não importa se o Ajax ou mesmo o F12 inspector ou algo assim), como:

$("<div/>").addClass('some-element').appendTo("body"); //new element will have blue color!

O plugin o iniciará instantaneamente. Também o plugin garante que um elemento seja inicializado apenas uma vez. Portanto, se você adicionar um elemento, .detach()a partir do corpo e o adicionar novamente, ele não será inicializado novamente.

$("<div/>").addClass('some-element').appendTo("body").detach()
    .appendTo(".some-container");
//initialized only once

O plug-in é baseado MutationObserver- ele funcionará no IE9 e 10 com dependências, conforme detalhado na página leia - me .


Por favor, adicione às npm.
thexpand

14

ou você pode simplesmente criar seu próprio evento , que acontece em qualquer lugar

 $("body").on("domChanged", function () {
                //dom is changed 
            });


 $(".button").click(function () {

          //do some change
          $("button").append("<span>i am the new change</span>");

          //fire event
          $("body").trigger("domChanged");

        });

Exemplo completo http://jsfiddle.net/hbmaam/Mq7NX/


este não é o mesmo ... o método descrito acima ainda é válido api.jquery.com/trigger
lefoy

10

Este é um exemplo usando o MutationObserver da Mozilla adaptado desta postagem do blog

Chrome 18+, Firefox 14+, IE 11+, Safari 6+

// Select the node that will be observed for mutations
var targetNode = document.getElementById('some-id');

// Options for the observer (which mutations to observe)
var config = { attributes: true, childList: true };

// Callback function to execute when mutations are observed
var callback = function(mutationsList) {
    for(var mutation of mutationsList) {
        if (mutation.type == 'childList') {
            console.log('A child node has been added or removed.');
        }
        else if (mutation.type == 'attributes') {
            console.log('The ' + mutation.attributeName + ' attribute was modified.');
        }
    }
};

// Create an observer instance linked to the callback function
var observer = new MutationObserver(callback);

// Start observing the target node for configured mutations
observer.observe(targetNode, config);

// Later, you can stop observing
observer.disconnect();

4

Use a interface MutationObserver como mostrado no blog de Gabriele Romanato

Chrome 18+, Firefox 14+, IE 11+, Safari 6+

// The node to be monitored
var target = $( "#content" )[0];

// Create an observer instance
var observer = new MutationObserver(function( mutations ) {
  mutations.forEach(function( mutation ) {
    var newNodes = mutation.addedNodes; // DOM NodeList
    if( newNodes !== null ) { // If there are new nodes added
        var $nodes = $( newNodes ); // jQuery set
        $nodes.each(function() {
            var $node = $( this );
            if( $node.hasClass( "message" ) ) {
                // do something
            }
        });
    }
  });    
});

// Configuration of the observer:
var config = { 
    attributes: true, 
    childList: true, 
    characterData: true 
};

// Pass in the target node, as well as the observer options
observer.observe(target, config);

// Later, you can stop observing
observer.disconnect();

3
MutationObserver é JavaScript nativo, não jQuery.
Benjamin

2

Que tal estender um jquery para isso?

   (function () {
        var ev = new $.Event('remove'),
            orig = $.fn.remove;
        var evap = new $.Event('append'),
           origap = $.fn.append;
        $.fn.remove = function () {
            $(this).trigger(ev);
            return orig.apply(this, arguments);
        }
        $.fn.append = function () {
            $(this).trigger(evap);
            return origap.apply(this, arguments);
        }
    })();
    $(document).on('append', function (e) { /*write your logic here*/ });
    $(document).on('remove', function (e) { /*write your logic here*/ ) });

O Jquery 1.9+ criou suporte para isso (ouvi falar que não testei).

Ao utilizar nosso site, você reconhece que leu e compreendeu nossa Política de Cookies e nossa Política de Privacidade.
Licensed under cc by-sa 3.0 with attribution required.