En utilisant javascript il est très facile de détecter les clics sur n'importe quel élément d'une page web, c'est encore plus facile avec un framework comme jQuery. Par contre c'est impossible à faire sur une iframe et son contenu.
La raison à ça est assez simple à comprendre : une iframe c'est comme un navigateur imbriqué dans une page web (exactement comme si la page ciblée par l'iframe se trouvait dans un autre onglet ou dans une autre fenêtre de navigateur).
En javascript, on n’a pas accès aux autres onglets pour des raisons évidentes de sécurité, et bien pour les iframe c'est la même chose, les navigateurs ne donnent pas accès au contenu d'une iframe via Javascript.
Lorsque l'iframe se trouve sur le même domaine que la page parente, le navigateur donne accès au contenu de l'iframe depuis la page parente, et vice-versa, mais c'est la seule exception à ces règles de sécurité.
Pourtant, il est quand même possible de détecter les clics sur une iframe en utilisant habillement l'événement blur et quelques variables...
Dans ce tutoriel, je vais donc vous présenter une technique "maison" qui permet de faire du tracking de clics sur une iframe (en utilisant jQuery), que l'on peut utiliser pour de nombreuses applications : tracking de clic sur un bouton "J'aime" Facebook, un bouton Google +1, un player youtube ou encore les clics sur les annonces Google Adsense (ou une autre régie de pub).
C'est parti !
Tracking de clic sur une iframe
Dans cette partie, je vais vous expliquer le fonctionnement général, le principe qui permet de détecter les clics.
Pour ça, on va travailler sur une page web très simple qui contient une iframe, comme ceci :
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Tracker les clics dans une iframe avec jQuery</title>
<link href="//netdna.bootstrapcdn.com/twitter-bootstrap/2.3.1/css/bootstrap.min.css" rel="stylesheet">
<style>
body{background:#efefef; padding:15px 20px;}
.iframetrack{margin:20px 0;}
#consoleDebug{position:fixed; top:30px; right:30px; z-index:9999; background:rgba(0,0,0,0.3);}
#consoleDebug .alert{margin:20px;}
</style>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.1/jquery.min.js"></script>
</head>
<body>
<p>Element actif : <span class="label" id="actif"></span></p>
<p>Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Nam cursus. Morbi ut mi. Nullam enim leo, egestas id, condimentum at, laoreet mattis, massa. Sed eleifend nonummy diam.</p>
<div class="iframetrack">
<iframe width="468" height="110" src="./sample-iframe/red.html" frameborder="0" allowtransparency="true" scrolling="no"></iframe>
</div>
<p>Sed eleifend nonummy diam. Praesent mauris ante, elementum et, bibendum at, posuere sit amet, nibh.</p>
<div id="consoleDebug"></div>
</body>
</html>
Le div #consoleDebug va simplement servir à afficher un message à chaque fois qu'un clic est détecté.
Au chargement d'une page web, le navigateur donne par défaut le focus à l'élément <body>, qui correspond en gros à toute la page web.
Qu'est-ce que le focus ?
Une page web est composée d'une arborescence d'éléments qu'on appelle le DOM. Certains de ses éléments comme des champs de formulaire (<input>, <textarea>), ou les liens (<a>) peuvent êtres marqués comme l'élément actif. C'est ça qu'on appelle le focus.
Lorsqu'un champ de formulaire a le focus, le curseur clignote à l'intérieur, et lorsqu'on appuie sur des touches du clavier, on écrit dans ce champ. En jQuery, on peut détecter lorsqu'un élément obtiens le focus, en utilisant l'événement .focus().
Mais ça n'est pas tout, il existe le contraire de focus, il s'agit de l'événement blur. Cet événement survient lorsqu'un élément perd le focus, ce qui est le cas par exemple lorsqu'on change de champ dans un formulaire.
Pourquoi je vous parle de ça ?
Et bien parce que l'événement blur va nous permettre de détecter le clic sur une iframe, car lorsqu'on clique sur une iframe, la page web perd le focus.
Le problème c'est qu'il y a plein d'autres cas dans lesquels la page reçoit l'événement blur, en voici quelques exemples :
- L'utilisateur change d'onglet
- L'utilisateur clique sur une autre fenêtre que celle du navigateur web qui affiche la page
Du coup il va falloir être en mesure de savoir si le blur a été provoqué par un clic sur une iframe, ou par autre chose.
Quand la souris survole une iframe ou au contraire revient dans la page après avoir survolé l'iframe, les événements mouseover et mouseout se produisent. Donc il est très facile de savoir si la souris est au dessus d'une iframe ou pas, en surveillant la frontière page web/iframe grâce à ces 2 événements.
Et bien voici le code javascript qui permet de faire tout ça avec jQuery :
jQuery(document).ready(function($){
// Affichage de l'élément actif (pour aider à comprendre ce qui se passe)
setInterval(function(){
$('#actif').text(document.activeElement.tagName);
}, 100);
// Initialisation variable
iframe_survol = false;
// Surveillance frontière
$('.iframetrack iframe').mouseover(function(){
iframe_survol = true;
}).mouseout(function(){
iframe_survol = false;
});
// On donne le focus à la fenêtre au chargement
$(window).focus();
// Ecoute blur
$(window).blur(function(e){
$('<div class="alert alert-info">').html("Clic sur l'iframe").appendTo('#consoleDebug').delay(3000).fadeOut();
});
// Retour du focus sur la page au survol
$(document).mousemove(function(e){
if( document.activeElement.tagName == 'IFRAME' ){
$(window).focus();
}
});
});
Voilà ce que ça donne en live :
Cette technique fonctionne, mais elle est assez lourde à mettre en place, et ne permet pas de gérer plusieurs iframes.
De plus, elle n'est pas compatible avec tous les navigateurs : Internet Explorer gère le blur de manière très différente des autres navigateurs, et certaines fonctions ne marchent pas sur Firefox, comme le $(window).focus();.
Plugin jQuery : iframeTracker
iframeTracker est un plugin jQuery que j'ai moi-même créé, et qui permet de faire la même chose que ce qui a été présenté dans la première partie, sauf qu'il est compatible avec tous les navigateurs (j'ai résolu les soucis de compatibilité avec IE8 et Firefox grâce à une astuce un peu complexe qu'il n'est pas nécessaire d'expliquer dans ce tutoriel).
De plus, ce plug-in permet de gérer un nombre d'iframe illimité, et d'effectuer différentes actions au survol de ces iframes grâce à des callback (fonctions appelées automatiquement par le plugin en réaction à des événements).
Je vous conseille vivement d'utiliser ce plugin plutôt que le code vu dans la première partie, qui n'est là que pour montrer le fonctionnement avec un exemple assez simple.
Vous pouvez le télécharger ici (version utilisée pour ce tutoriel, avec les commentaires en français) : jquery.iframetracker.fr.js ou alors sur GitHub : iframeTracker-jquery.
Voici comment il s'utilise :
jQuery(document).ready(function($){
// Facebook iframe
$('.socialiframetrack_facebook iframe').iframeTracker({
blurCallback: function(){
$('<div class="alert alert-info">').html('Click on Facebook iframe').appendTo('#consoleDebug').delay(3000).fadeOut();
}
});
// Autres iframes (entourées par un élément de classe CSS .iframetrack)
$('.iframetrack iframe').iframeTracker({
blurCallback: function(){
$('<div class="alert alert-info">').html('Click on iframe : #' + this._overId).appendTo('#consoleDebug').delay(3000).fadeOut();
},
overCallback: function(element){
// Mémorisation de l'id de l'iframe survollée
this._overId = $(element).parents('.iframetrack').attr('id');
},
outCallback: function(element){
// Reset lorsque la souris sort de l'iframe et revient dans la fenêtre
this._overId = null;
},
_overId: null
});
});
C'est très simple, il faut utiliser un sélecteur qui match toutes les iframes que vous voulez "écouter" avec un sélecteur jQuery, et d'appeler la fonction iframeTracker en lui passant en paramètre un objet qui possède ces slots :
- blurCallback
obligatoire
Cette fonction est appelée lorsque la fenêtre perd le focus alors que le pointeur de la souris est au dessus d'une iframe parmi celles matchées par le sélecteur (car il peut y en avoir plusieurs) - overCallback
facultatif
Cette fonction est appelée lorsque la souris entre dans une iframe écoutée par le sélecteur.
Elle prend en paramètre l'élément qui représente l'iframe survolée.
C'est très pratique car on peut alors mémoriser l'iframe actuellement survolée lorsque le sélecteur match plusieurs iframe. Dans l'exemple, je stocke cette information dans la variable_overIdque j'utilise ensuite dans le blurCallback. - outCallback
facultatif
Réciproque de overCallback, cette fonction est appelée lorsque la souris ressort de l'iframe pour revenir dans la page web.
Ensuite vous pouvez parfaitement ajouter des attributs supplémentaires pour stocker les différentes variables dont vous avez besoin dans vos callbacks, comme je l'ai fait avec _overId.
Voilà ce que ça donne :
Encore faim ? allez lire ça : zombie poulpe !
Un gros mercis et un grand bravo pour ce "petit" code qui m'a fait economiser un certain temps :). J'avais commencer à le faire lorsque je me suis dis, tiens ça existe peut être.
Merci beaucoup.
Cdt, Mathieu.
Thank you for the script and even more for the explanation on how it works. Helped a lot, cant tank you enough
Il suffirait juste d'ajouter :
$(window).blur(function(e){
if(iframe_survol) {
}
}
pour le faire fonctionner
Est-ce que tu penses que c'est enviseagable pour tracker des events dans google analytics ?
If you place the two iframes side by side (with margin/padding = 0) you'll get a bug. If you click on the first iframe you'll get a message about click. If you move your mouse to the second iframe and click on it you'll also se a message about click. BUT if you'll try to move mouse to the first iframe and click again you'll get a bug. You'll never see a message about click.
To solve this issue you have to add $(window).focus(); on mouseout event.
// Surveillance frontière
$('.iframetrack iframe').mouseover(function(){
iframe_survol = true;
}).mouseout(function(){
iframe_survol = false;
$(window).focus();
});
Great article. I am facing a similar problem when clicking an iframe and nothing happens. I would like to click in an iframe and open the link in a new tab with jQuery UI, but it does not work, and the new link opens in the same tab. However, if I click on any point on the screen that is outside the iframe the new tab is created. I tried to use the jQuery Plugin iframeTracker but no success. I posted an example of the code in the link (Site Web), and if you can help me I will be grateful.
Kind regards,
If the iframe is not on the same domain, it's impossible to access the iframe content.
Is it possible to use this on an iframe that displays viedoa in order to change the click so instead of starting the video it will pop up a modal/lightbox?
I added the plugin code and then:
jQuery(document).ready(function($){ // Other iframes (wrapped with .iframetrack) $('.iframetrack iframe').iframeTracker({ blurCallback: function(){ alert('test1'); }, overCallback: function(element){ this._overId = $(element).parents('.iframetrack').attr('id'); // Saving the iframe wrapper id alert('test2'); }, outCallback: function(element){ this._overId = null; // Reset hover iframe wrapper id }, _overId: null }); });But nothing happens. The video still plays and the alert from my test does not display.
I imagine to stop the video from playing that more needs to be done but at least to get the alert to display to know I am on the right track.
Thanks!Of course I wrapped the iframe with the iframeTracker class.
J'ai pourtant aperçu, pour moi du moins, qu'il n'a pas l'air de marcher sur Chrome ou Internet Explorer. Y en a-t-il d'autres qui on recontré le même problème?
Eric
http://www.finalclap.com/ressources/exemple/jquery-iframe-track/simple.html
http://www.finalclap.com/ressources/exemple/jquery-iframe-track/
Mais on m'a déjà remonté ce problème, ici : https://github.com/finalclap/iframeTracker-jquery/issues/1
Apparemment ça serait dû aux réglages de chrome. En tout cas je ne peux pas le corriger à partir du moment où je ne peux pas le reproduire, mais si quelqu'un sait comment le résoudre, pull request sur github ^^
Merci bien de ce plugin. Ca fait trois semaines que j'essaie de trouver quelque chose pareille et voila enfin. Mais je souhaiterais vous demander plus de details sur mon cas specialement si vous le permettez:
Moi dans ma page j'ai un iframe d'un domaine que je ne controle pas. Cette iframe affiche un formulaire ou il y a deux boutons "Retour" (situe a gauche) et "Suite" (situe a droite). Est-il possible d'utiliser votre plugin pour savoir combien de clic a eu lieu sur le bouton "suite" et sur le bouton "retour" ? Le but de ma question c'est que je souhaiterais apres un certain nombre de clics sur le bouton "Suite" lancer un event tracker ou conversion google analytics.
Merci.
-Fadi
votre plug in m'a beaucoup aidé, vraiment c'est un trés bon travail de votre part, je vous encourage à continuer dans cette voie.
Je l'ai utilisé pour récupere l'id ou le src d'une video youtube dans mon site lors du clique sur le bouton play.
J'ai pu la récupérer en javascript(comme dans votre exemple) mais c'est possible de la transmettre dans un fichier php.c'est à dire je veux que le contenu de la variable que je recupere en javascript je l'insere dans une table(bdd). j'ai utilisé ajaxe et ça n'a pas marché...
i'm using the iframe tracker longly. But now i'm running into trouble with the Spotify embed iFrame. I want to track if the user has clicked the spotify embed Player, but there comes no answer from the blurCallback. I debugged this, but finally I don't got a satisfying solution that works stable.
Do you know anything about problems with the spotify iFrame?
Best
Never heard about using iframeTracker to track a spotify player iframe, can you provide a sample test page ?
Thanks
comment on fait pour détecter le clique sur une PUB google ?