Carnet Wiki

Une structure pour JS

Version 8 — August 2015 — roustoubi

Placido : Voici une proposition d’organisation de vos fonctions js.
Il s’agit d’une approche globale, qui privilégie le chargement d’un seul fichier, quelque soit la page du site.

La première partie du fichier contient vos fonctions.
La seconde partie les rassemble en séquence d’éxécution.

App.init() -> lancement initial
App.reboot() -> exécution “perdurante”, qui se relance lors d’un rechargement ajax de spip

Les conditions de traitement des éléments se font dans les fonctions.
Vous NB : vous pouvez remplacer les occurrences de ’App’ par le prefix de votre plugin par exemple.

Insérer ce fichier, ainsi que son appel dans le head comme bon vous semble, par exemple via insert_head ainsi :

<?php
function monplugin_insert_head($flux){
    // les js à inclure quelque soit la page
  $js = array(
    'App.js',
    //'pluginX.js',
    );
 
 
foreach( $js as $script ){
    if( $path = find_in_path("javascript/$script") )
      $flux .= '<script type="text/javascript" src="'. $path .'"></script>';
  }
 
 
return $flux;
}
?>
//////////////
// App.js //
/////////////
 
 
var App = function () {
 
 
var fn1 = function() {
//exemple de test conditionnel : 
// fn1 s'applique uniquement sur la page sommaire
    if ($('.page_sommaire').length == ) return false;
        console.log('fn1');
    }
 
 
var fn2 = function()  {
        console.log('fn2');
    }
 
 
var fn3 = function() {
        console.log('fn3');
    }
 
 
///////////////////////////////////
    return {
        // l'ordre des fonctions importe
        init: function () {
            fn1();
            fn3();
 
 
// surveiller le rechargement ajax
            if (typeof onAjaxLoad === 'function') {
                onAjaxLoad(App.reboot);
            } 
        },
 
 
// ici les fonctions à relancer à la suite d'un rechargement ajax de SPIP
        reboot: function () {
            fn2();
        }
    };@@@SPIP_DIFF0@@@
}();@@@SPIP_DIFF1@@@ @@@SPIP_DIFF2@@@
}();&lt;/@@@SPIP_DIFF1@@@ @@@SPIP_DIFF2@@@code@@@SPIP_DIFF1@@@ @@@SPIP_DIFF2@@@>@@@SPIP_DIFF1@@@ 
 
 
@@@SPIP_DIFF18@@@//GO !
$(function(){App.init()});@@@SPIP_DIFF1@@@
 
 
@@@SPIP_DIFF18@@@

NB :
Si vous avez recours à des fonctions qui ajoutent des écouteurs d’événements (“bind”) et qui doivent se relancer à rechargement ajax de SPIP ( comme fn2 dans notre exemple) , pensez à limiter l’empilement de ces dits “binds”.
ex :
$.('a.click-to-action').unbind().click(function(e) {...});